diff --git a/.isort.cfg b/.isort.cfg index d3ff88a..5835cbb 100644 --- a/.isort.cfg +++ b/.isort.cfg @@ -3,6 +3,6 @@ line_length=120 multi_line_output=0 sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,PGA,LOCALFOLDER default_section=THIRDPARTY -known_pga=pganonymizer +known_pga=pganonymize no_lines_before=LOCALFOLDER diff --git a/MANIFEST.in b/MANIFEST.in index 5f4027b..db2a0b2 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,4 +2,4 @@ include LICENSE.rst include README.rst include CHANGELOG.md -recursive-include pganonymizer *.html *.js *.css *.png *.gif*.jpg *.jpeg *.svg *.po \ No newline at end of file +recursive-include pganonymize *.html *.js *.css *.png *.gif*.jpg *.jpeg *.svg *.po diff --git a/Makefile b/Makefile index ea43309..ac94085 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ BROWSER ?= xdg-open -PYTHON_PACKAGE = pganonymizer +PYTHON_PACKAGE = pganonymize TESTS_PACKAGE = tests .PHONY: clean clean-test clean-pyc clean-build docs help @@ -61,4 +61,4 @@ test: @poetry run pytest --cov=poetry --cov-config .coveragerc tests/ -sq test-all: ## run tests on every Python version with tox - @tox \ No newline at end of file + @tox diff --git a/README.rst b/README.rst index b3af0d8..2bbbfe7 100644 --- a/README.rst +++ b/README.rst @@ -136,7 +136,7 @@ If you want to run the anonymizer within a Docker container you first have to bu .. code-block:: sh - $ docker build -t pganonymizer . + $ docker build -t pganonymize . After that you can pass a schema file to the container, using Docker volumes, and call the anonymizer: @@ -144,7 +144,7 @@ After that you can pass a schema file to the container, using Docker volumes, an $ docker run \ -v :/schema.yml \ - -it pganonymizer \ + -it pganonymize \ /usr/local/bin/pganonymize \ --schema=/schema.yml \ --dbname= \ diff --git a/docs/Makefile b/docs/Makefile index b6f4929..9cb0448 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -85,17 +85,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pganonymizer.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pganonymize.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pganonymizer.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pganonymize.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/pganonymizer" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pganonymizer" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pganonymize" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pganonymize" @echo "# devhelp" epub: diff --git a/docs/api.rst b/docs/api.rst index 47b33ee..4ac86b4 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,4 +4,4 @@ API .. toctree:: :maxdepth: 4 - pganonymizer + pganonymize diff --git a/docs/conf.py b/docs/conf.py index fa56b9a..4f535cd 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -194,7 +194,7 @@ #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'pganonymizerdoc' +htmlhelp_basename = 'pganonymizedoc' # -- Options for LaTeX output ------------------------------------------ diff --git a/docs/pganonymizer.rst b/docs/pganonymize.rst similarity index 59% rename from docs/pganonymizer.rst rename to docs/pganonymize.rst index e210de0..f460a56 100644 --- a/docs/pganonymizer.rst +++ b/docs/pganonymize.rst @@ -1,53 +1,53 @@ -pganonymizer package +pganonymize package ==================== Submodules ---------- -pganonymizer.cli module +pganonymize.cli module ----------------------- -.. automodule:: pganonymizer.cli +.. automodule:: pganonymize.cli :members: :undoc-members: :show-inheritance: -pganonymizer.constants module +pganonymize.constants module ----------------------------- -.. automodule:: pganonymizer.constants +.. automodule:: pganonymize.constants :members: :undoc-members: :show-inheritance: -pganonymizer.exceptions module +pganonymize.exceptions module ------------------------------ -.. automodule:: pganonymizer.exceptions +.. automodule:: pganonymize.exceptions :members: :undoc-members: :show-inheritance: -pganonymizer.providers module +pganonymize.providers module ----------------------------- -.. automodule:: pganonymizer.providers +.. automodule:: pganonymize.providers :members: :undoc-members: :show-inheritance: -pganonymizer.utils module +pganonymize.utils module ------------------------- -.. automodule:: pganonymizer.utils +.. automodule:: pganonymize.utils :members: :undoc-members: :show-inheritance: -pganonymizer.version module +pganonymize.version module --------------------------- -.. automodule:: pganonymizer.version +.. automodule:: pganonymize.version :members: :undoc-members: :show-inheritance: @@ -56,7 +56,7 @@ pganonymizer.version module Module contents --------------- -.. automodule:: pganonymizer +.. automodule:: pganonymize :members: :undoc-members: :show-inheritance: diff --git a/pganonymize/providers.py b/pganonymize/providers.py index 41cad97..f27e420 100644 --- a/pganonymize/providers.py +++ b/pganonymize/providers.py @@ -22,7 +22,7 @@ def register(self, provider_class, provider_id): """ Register a provider class. - :param pganonymizer.providers.Provider provider_class: Provider class that should be registered + :param pganonymize.providers.Provider provider_class: Provider class that should be registered :param str provider_id: A string id to register the provider for :raises ProviderAlreadyRegistered: If another provider with the given id has been registered """