aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-01-18 07:06:11 -0600
committerEugene Triguba <eugenetriguba@gmail.com>2020-01-18 07:06:11 -0600
commitb7a4b02fa5c4a43399edab0de14e7db2a33a3990 (patch)
tree20e02218d10bc017b053fdaa425076fc5895bbc9
parentBump version: 0.3.2 → 0.3.3 (diff)
downloadconfig-file-b7a4b02fa5c4a43399edab0de14e7db2a33a3990.zip
Proof read markdown files
-rw-r--r--CHANGELOG.md43
-rw-r--r--CONTRIBUTING.md13
-rw-r--r--README.md4
3 files changed, 37 insertions, 23 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e6d2c30..0e699e5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
Fixed
-- `TypeError` when setting the key/value pairs since configparser requires the option
+ - `TypeError` when setting the key/value pairs since configparser requires the option
to be a string. The parser now just converts the value to a string if it is not one
and then adds the key/value pair. It would still be parsed correctly when retrieving
it.
@@ -18,46 +18,55 @@ Fixed
Changed
-- `_split_on_dot` is no longer in base parser (now in a utils file). Also, the default
+ - `_split_on_dot` is no longer in base parser (now in a utils file). Also, the default
behavior is now to split on every dot and split on only the last dot if specified
Fixed
-- `ConfigFile` was trying to use `_split_on_dot`, but it no longer inherited from base parser.
+ - `ConfigFile` was trying to use `_split_on_dot`, but it no longer inherited from base parser.
## 0.3.1 - 2020-01-17
Fixed
-- `isinstance` call for `BaseParser` to be correctly used.
+ - `isinstance` call for `BaseParser` to be correctly used.
## 0.3.0 - 2020-01-17
Added
-- Abstract base parser as a contract for concrete file format parser implementations.
-- Exposed `ConfigFile`, `BaseParser`, and `ParsingError` to the Public API. The base
+ - Abstract base parser as a contract for concrete file format parser implementations.
+
+ - Exposed `ConfigFile`, `BaseParser`, and `ParsingError` to the Public API. The base
parser is exposed to allow future custom extensions of the config file and what it
can parse by its users.
-- `has_section` and `has_key` is now changed to a single `has` method which determines
- whether you're checking a section or key by the presence of a dot.
-- `IniParser` to support the ini format. It uses configparser internally, but it is
+
+ - `has_section` and `has_key` is now changed to a single `has` method which determines
+ whether you're checking a section or key by the presence of a dot.
+
+ - `IniParser` to support the ini format. It uses configparser internally, but it is
only exposed through the `ConfigFile` object.
## 0.2.0 - 2020-01-04
Added
-- Parsing of strings to their native values
+ - Parsing of strings to their native values
## 0.1.0 - 2020-01-04
Added
-- Created the config_file package with only the version inside it
-- toml and pyyaml to dependencies
-- Pre-commit pipeline with autoflake, isort, black, and flake8
-- MIT license
-- Contributing guidelines
-- bump2version for easily upgrading versions of config file
-- pytest to dev dependencies for testing later on \ No newline at end of file
+ - Created the config_file package with only the version inside it
+
+ - toml and pyyaml to dependencies
+
+ - Pre-commit pipeline with autoflake, isort, black, and flake8
+
+ - MIT license
+
+ - Contributing guidelines
+
+ - bump2version for easily upgrading versions of config file
+
+ - pytest to dev dependencies for testing later on \ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a2e3a55..9a0dcc0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,21 +32,26 @@ Here are some guidelines to keep in mind when submitting a pull request:
- Unit tests are written using [pytest](https://docs.pytest.org/en/latest/).
- Pre-commit pipeline: We use a pre-commit pipeline to ensure standard code format.
+
- Unused imports are automatically removed using `autoflake <https://github.com/myint/autoflake>`_
+
- The remaining imports are sorted using `isort <https://github.com/timothycrosley/isort>`_.
+
- All code is automatically formatted with `black <https://github.com/psf/black>`_
+
- Lastly, everything is checked by `flake8 <https://gitlab.com/pycqa/flake8>`_.
Make sure to install pre-commit before making commits.
Note: if any of the items had to do any reformatting, sorting, etc., the commit will
- fail. You'll have to re-add the items they fixed and try again.
-
- .. code-block::
+ fail. You'll have to re-add the items it fixed and try again.
+ ```bash
pre-commit install
+ ```
- If the pipeline is acting oddly, you can skip it with the ``--no-verify`` option to ``git push``.
+ If the pipeline is acting oddly, you can skip it with the ``--no-verify`` option
+ to ``git push``.
To get started, make sure you have poetry installed and run ``poetry install`` and
``poetry shell`` to enter the virtual environment. \ No newline at end of file
diff --git a/README.md b/README.md
index fb6c845..83a5e76 100644
--- a/README.md
+++ b/README.md
@@ -15,9 +15,9 @@ YAML, and TOML configuration files. For the time being, it only supports INI.
With applications I was building, I found myself frequently having to use some sort of configuration folder with an object that modeled the configuration file. I did this to help more easily manipulate my configuration. However, I found myself needing this sort of thing for several different applications and would end up rewriting something similar. So ended up deciding to create a package out of it so I could focus more on the application I was building instead.
-## Why not just use configparser, ConfigObj, etc.?
+## Why not just use configparser, ConfigObj, etc.
-I wanted something a bit cleaner and simpler to use than configparser. The ini parser uses configparser under the hood, but it provides some niceties such as automatically parsing configuration values into their native types when you retrieve them. However, I also wanted something more flexible, and ini files aren't the only common configuration format. That is why Config File uses an adapter pattern to swap in and out the right parser for various file types you give it. This allows you to use the same API for all of your configuration needs.
+I wanted something a bit cleaner to use than configparser. The ini parser uses configparser under the hood, but it provides some niceties such as automatically parsing configuration values into their native types when you retrieve them. However, I also wanted something more flexible, and ini files aren't the only common configuration format. That is why Config File uses an adapter pattern to swap in and out the right parser for various file types you give it. This allows you to use the same API for all of your configuration needs.
## Installation
```bash