Skip to content

Commit

Permalink
fix doc issues for 2.0 (#12)
Browse files Browse the repository at this point in the history
* Bump bleach from 3.2.1 to 3.3.0

Bumps [bleach](https://github.com/mozilla/bleach) from 3.2.1 to 3.3.0.
- [Release notes](https://github.com/mozilla/bleach/releases)
- [Changelog](https://github.com/mozilla/bleach/blob/master/CHANGES)
- [Commits](mozilla/bleach@v3.2.1...v3.3.0)

Signed-off-by: dependabot[bot] <[email protected]>

* update deprecated import and reformat w/ black

* reformatted all code w/ black

* update Pipfile.lock

* v2.0 release candidate (fixes #9, fixes #9) (#10)

* changelog

* add test for bug

* use brackets for lists in env vars

* update README and tests

* README

* modularize environment variable management

* new modular architecture

* type utils

* pluggable providers

* fix circular imports when running unit tests from root directory

* documentation

* docs

Co-authored-by: Chris Haumesser <[email protected]>

* update README

* remove old python versions

* rtd updates

* typo

* rtd

* rtd

* rtd

* fix issues w/ python 3.8 typing

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Chris Haumesser <[email protected]>
  • Loading branch information
3 people authored Apr 12, 2022
1 parent 8870827 commit f27029f
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 16 deletions.
12 changes: 12 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2
build:
os: "ubuntu-20.04"
tools:
python: "3.8"
sphinx:
configuration: docs/conf.py
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
22 changes: 15 additions & 7 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
CHANGES
=======

v2.0.1
------

* rtd
* rtd
* rtd
* typo
* rtd updates
* remove old python versions
* try to fix docs theme
* try to fix docs theme
* ChangeLog
* fix docs issue

v2.0.0
------

* ChangeLog
* v2.0 release (#11)
* update README
* v2.0 release candidate (fixes #9, fixes #9) (#10)
* update Pipfile.lock
* reformatted all code w/ black
* update deprecated import and reformat w/ black
* Bump bleach from 3.2.1 to 3.3.0

v1.0.4
------
Expand Down
2 changes: 1 addition & 1 deletion cfitall/providers/filesystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class FilesystemProvider(ConfigProviderBase):
prefix: str

def __init__(
self, path: list[str], prefix: str, provider_name: str = "filesystem"
self, path: List[str], prefix: str, provider_name: str = "filesystem"
) -> None:
"""
FilesystemProvider attempts to read json or yaml configuration files
Expand Down
4 changes: 2 additions & 2 deletions cfitall/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def all(self) -> Dict:
return values

@property
def config_keys(self) -> list[str]:
def config_keys(self) -> List[str]:
"""
Returns a list of currently used configuration keys as dotted paths, for
use with the get() or set() methods.
Expand All @@ -88,7 +88,7 @@ def dict(self) -> Dict:
return self._merge_configs()

@property
def env_vars(self) -> list[str]:
def env_vars(self) -> List[str]:
"""
Returns a list of environment variables known from config files and defaults
"""
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

import sphinx_rtd_theme

here = os.path.dirname(os.path.abspath(__file__))
cfitall_path = os.path.join(here, "..", "cfitall")
sys.path.insert(0, cfitall_path)
# here = os.path.dirname(os.path.abspath(__file__))
# cfitall_path = os.path.join(here, "..", "cfitall")
# sys.path.insert(0, cfitall_path)
print(sys.path)


Expand Down
8 changes: 5 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@ author = Chris Haumesser
author-email = [email protected]
summary = a configuration manager for python apps
description-file = README.rst
requires-python = >=3.6
requires-python = >=3.8
home-page = https://github.com/wryfi/cfitall
classifier =
License :: OSI Approved :: MIT License
Natural Language :: English
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10

[options]
packages = find:
install_requires =
PyYAML <=6

[files]
data_files =
Expand Down

0 comments on commit f27029f

Please sign in to comment.