feat: rename project from "flake8-nitpick" to "nitpick"

.github/ISSUE_TEMPLATE/bug-report.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 Your bug may already be reported!
-Please search on the [issue tracker](https://github.com/andreoliwa/flake8-nitpick/issues) before creating one.
+Please search on the [issue tracker](https://github.com/andreoliwa/nitpick/issues) before creating one.
 
 ## Expected Behavior
 
@@ -41,11 +41,11 @@ Please search on the [issue tracker](https://github.com/andreoliwa/flake8-nitpic
 
 <!--- Include as many relevant details about the environment you experienced the bug in -->
 
-- `flake8-nitpick` version used:
+- `nitpick` version used:
 - Python version:
 - Operating System and version:
 - Link to your project:
 
-For more information, see the [CONTRIBUTING](https://github.com/andreoliwa/flake8-nitpick/blob/master/CONTRIBUTING.rst) guide.
+For more information, see the [CONTRIBUTING](https://github.com/andreoliwa/nitpick/blob/master/CONTRIBUTING.rst) guide.
 
 <!-- Thanks to https://github.com/stevemao/github-issue-templates/ for this template -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 Your feature may already be reported!
-Please search on the [issue tracker](https://github.com/andreoliwa/flake8-nitpick/issues) before creating one.
+Please search on the [issue tracker](https://github.com/andreoliwa/nitpick/issues) before creating one.
 
 ## Expected Behavior
 
@@ -27,6 +27,6 @@ Please search on the [issue tracker](https://github.com/andreoliwa/flake8-nitpic
 <!--- How has this issue affected you? What are you trying to accomplish? -->
 <!--- Providing context helps us come up with a solution that is most useful in the real world -->
 
-For more information, see the [CONTRIBUTING](https://github.com/andreoliwa/flake8-nitpick/blob/master/CONTRIBUTING.rst) guide.
+For more information, see the [CONTRIBUTING](https://github.com/andreoliwa/nitpick/blob/master/CONTRIBUTING.rst) guide.
 
 <!-- Thanks to https://github.com/stevemao/github-issue-templates/ for this template -->

.pre-commit-config.yaml

@@ -44,7 +44,7 @@ repos:
     rev: v2.2.3
     hooks:
       - id: flake8
-        additional_dependencies: ['flake8-nitpick', 'flake8-blind-except', 'flake8-bugbear', 'flake8-comprehensions', 'flake8-debugger', 'flake8-docstrings', 'flake8-isort', 'flake8-mypy', 'flake8-polyfill', 'flake8-pytest', 'flake8-quotes', 'yesqa']
+        additional_dependencies: ['flake8-blind-except', 'flake8-bugbear', 'flake8-comprehensions', 'flake8-debugger', 'flake8-docstrings', 'flake8-isort', 'flake8-mypy', 'flake8-polyfill', 'flake8-pytest', 'flake8-quotes', 'yesqa'] # FIXME: add nitpick again when it's on PyPI
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.701
     hooks:

.travis/script.sh

@@ -14,4 +14,4 @@ else
 fi
 
 echo "Running coverage report"
-coverage run --parallel-mode --source=flake8_nitpick -m pytest
+coverage run --parallel-mode --source=nitpick -m pytest

CONTRIBUTING.rst

@@ -5,41 +5,41 @@ Contributing
 Contributions are welcome, and they are greatly appreciated!
 Every little bit helps, and credit will always be given.
 
-Check the `projects on GitHub <https://github.com/andreoliwa/flake8-nitpick/projects>`_, you might help coding a planned feature.
+Check the `projects on GitHub <https://github.com/andreoliwa/nitpick/projects>`_, you might help coding a planned feature.
 
 Bug reports or feature requests
 ===============================
 
-* First, search the `GitHub issue tracker <https://github.com/andreoliwa/flake8-nitpick/issues>`_ to see if your bug/feature is already there.
-* If nothing is found, just `add a new issue and follow the instructions there <https://github.com/andreoliwa/flake8-nitpick/issues/new/choose>`_.
+* First, search the `GitHub issue tracker <https://github.com/andreoliwa/nitpick/issues>`_ to see if your bug/feature is already there.
+* If nothing is found, just `add a new issue and follow the instructions there <https://github.com/andreoliwa/nitpick/issues/new/choose>`_.
 
 Documentation improvements
 ==========================
 
-flake8-nitpick could always use more documentation, whether as part of the
+nitpick could always use more documentation, whether as part of the
 official docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Development
 ===========
 
-To set up ``flake8-nitpick`` for local development:
+To set up ``nitpick`` for local development:
 
-1. Fork `flake8-nitpick <https://github.com/andreoliwa/flake8-nitpick>`_
+1. Fork `nitpick <https://github.com/andreoliwa/nitpick>`_
    (look for the "Fork" button).
 
 2. Clone your fork locally::
 
     cd ~/Code
-    git clone git@github.com:your_name_here/flake8-nitpick.git
-    cd flake8-nitpick
+    git clone git@github.com:your_name_here/nitpick.git
+    cd nitpick
 
 3. `Install Poetry globally using the recommended way <https://github.com/sdispater/poetry#installation>`_.
 
 4. Create your virtualenv with pyenv (or some other tool you prefer)::
 
-    pyenv virtualenv 3.6.8 flake8-nitpick
-    pyenv activate flake8-nitpick
+    pyenv virtualenv 3.6.8 nitpick
+    pyenv activate nitpick
 
 5. Install packages::
 
@@ -89,6 +89,6 @@ For merging, you should:
 3. Add yourself to ``AUTHORS.rst``.
 
 .. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
-       `run the tests <https://travis-ci.com/andreoliwa/flake8-nitpick/pull_requests>`_ for each change you add in the pull request.
+       `run the tests <https://travis-ci.com/andreoliwa/nitpick/pull_requests>`_ for each change you add in the pull request.
 
        It will be slower though ...

Makefile

@@ -16,5 +16,6 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	sphinx-apidoc -f -o docs/source flake8_nitpick/
+	rm -rf docs/source
+	sphinx-apidoc --force --module-first --separate --implicit-namespaces --output-dir docs/source nitpick/
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -1,15 +1,15 @@
-# flake8-nitpick
-
-[![PyPI](https://img.shields.io/pypi/v/flake8-nitpick.svg)](https://pypi.python.org/pypi/flake8-nitpick)
-[![Travis CI](https://travis-ci.com/andreoliwa/flake8-nitpick.svg?branch=master)](https://travis-ci.com/andreoliwa/flake8-nitpick)
-[![Documentation Status](https://readthedocs.org/projects/flake8-nitpick/badge/?version=latest)](https://flake8-nitpick.readthedocs.io/en/latest/?badge=latest)
-[![Coveralls](https://coveralls.io/repos/github/andreoliwa/flake8-nitpick/badge.svg?branch=master)](https://coveralls.io/github/andreoliwa/flake8-nitpick?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/901b4b62293cf7f2c4bc/maintainability)](https://codeclimate.com/github/andreoliwa/flake8-nitpick/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/901b4b62293cf7f2c4bc/test_coverage)](https://codeclimate.com/github/andreoliwa/flake8-nitpick/test_coverage)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/flake8-nitpick.svg)](https://pypi.org/project/flake8-nitpick/)
-[![Project License](https://img.shields.io/pypi/l/flake8-nitpick.svg)](https://pypi.org/project/flake8-nitpick/)
+# nitpick
+
+[![PyPI](https://img.shields.io/pypi/v/nitpick.svg)](https://pypi.python.org/pypi/nitpick)
+[![Travis CI](https://travis-ci.com/andreoliwa/nitpick.svg?branch=master)](https://travis-ci.com/andreoliwa/nitpick)
+[![Documentation Status](https://readthedocs.org/projects/nitpick/badge/?version=latest)](https://nitpick.readthedocs.io/en/latest/?badge=latest)
+[![Coveralls](https://coveralls.io/repos/github/andreoliwa/nitpick/badge.svg?branch=master)](https://coveralls.io/github/andreoliwa/nitpick?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/901b4b62293cf7f2c4bc/maintainability)](https://codeclimate.com/github/andreoliwa/nitpick/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/901b4b62293cf7f2c4bc/test_coverage)](https://codeclimate.com/github/andreoliwa/nitpick/test_coverage)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/nitpick.svg)](https://pypi.org/project/nitpick/)
+[![Project License](https://img.shields.io/pypi/l/nitpick.svg)](https://pypi.org/project/nitpick/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=andreoliwa/flake8-nitpick)](https://dependabot.com)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=andreoliwa/nitpick)](https://dependabot.com)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 Flake8 plugin to enforce the same lint configuration (flake8, isort, mypy, pylint) across multiple Python projects.
@@ -32,10 +32,10 @@ A "nitpick code style" is a [TOML](https://github.com/toml-lang/toml) file with
 
 Simply install the package (in a virtualenv or globally, wherever) and run `flake8`:
 
-    $ pip install -U flake8-nitpick
+    $ pip install -U nitpick
     $ flake8
 
-You will see warnings if your project configuration is different than [the default style file](https://raw.githubusercontent.com/andreoliwa/flake8-nitpick//0.13.1/nitpick-style.toml/nitpick-style.toml).
+You will see warnings if your project configuration is different than [the default style file](https://raw.githubusercontent.com/andreoliwa/nitpick//0.13.1/nitpick-style.toml/nitpick-style.toml).
 
 ## Style file
 
@@ -44,7 +44,7 @@ You will see warnings if your project configuration is different than [the defau
 Change your project config on `pyproject.toml`, and configure your own style like this:
 
     [tool.nitpick]
-    style = "https://raw.githubusercontent.com/andreoliwa/flake8-nitpick//0.13.1/nitpick-style.toml/nitpick-style.toml"
+    style = "https://raw.githubusercontent.com/andreoliwa/nitpick//0.13.1/nitpick-style.toml/nitpick-style.toml"
 
 You can set `style` with any local file or URL. E.g.: you can use the raw URL of a [GitHub Gist](https://gist.github.com).
 
@@ -62,7 +62,7 @@ If a key is defined in more than one file, the value from the last file will pre
 
 2. Any `nitpick-style.toml` file found in the current directory (the one in which `flake8` runs from) or above.
 
-3. If no style is found, then [the default style file from GitHub](https://raw.githubusercontent.com/andreoliwa/flake8-nitpick//0.13.1/nitpick-style.toml/nitpick-style.toml) is used.
+3. If no style is found, then [the default style file from GitHub](https://raw.githubusercontent.com/andreoliwa/nitpick//0.13.1/nitpick-style.toml/nitpick-style.toml) is used.
 
 ### Style file syntax
 

docs/conf.py

@@ -17,7 +17,7 @@
 # sys.path.insert(0, os.path.abspath('.'))
 
 # -- Project information -----------------------------------------------------
-project = "flake8-nitpick"
+project = "nitpick"
 copyright = "2019, W. Augusto Andreoli"
 author = "W. Augusto Andreoli"
 
@@ -119,7 +119,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "flake8-nitpickdoc"
+htmlhelp_basename = "nitpickdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -142,14 +142,14 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [(master_doc, "flake8-nitpick.tex", "flake8-nitpick Documentation", "W. Augusto Andreoli", "manual")]
+latex_documents = [(master_doc, "nitpick.tex", "nitpick Documentation", "W. Augusto Andreoli", "manual")]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "flake8-nitpick", "flake8-nitpick Documentation", [author], 1)]
+man_pages = [(master_doc, "nitpick", "nitpick Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -160,10 +160,10 @@
 texinfo_documents = [
     (
         master_doc,
-        "flake8-nitpick",
-        "flake8-nitpick Documentation",
+        "nitpick",
+        "nitpick Documentation",
         author,
-        "flake8-nitpick",
+        "nitpick",
         "Flake8 plugin to enforce the same lint configuration (flake8, isort, mypy, pylint)"
         + " across multiple Python projects",
         "Miscellaneous",
@@ -218,4 +218,4 @@
 # -- Options for extlinks extension ---------------------------------------
 
 # http://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#confval-extlinks
-extlinks = {"issue": ("https://github.com/andreoliwa/flake8-nitpick/issues/%s", "issue ")}
+extlinks = {"issue": ("https://github.com/andreoliwa/nitpick/issues/%s", "issue ")}

docs/index.rst

@@ -1,5 +1,5 @@
-Welcome to flake8-nitpick's documentation!
-==========================================
+Welcome to nitpick's documentation!
+===================================
 
 .. toctree::
    :maxdepth: 2

docs/source/modules.rst

@@ -1,7 +1,7 @@
-flake8_nitpick
-==============
+nitpick
+=======
 
 .. toctree::
    :maxdepth: 4
 
-   flake8_nitpick
+   nitpick

docs/source/nitpick.config.rst

@@ -0,0 +1,7 @@
+nitpick.config module
+=====================
+
+.. automodule:: nitpick.config
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/nitpick.constants.rst

@@ -0,0 +1,7 @@
+nitpick.constants module
+========================
+
+.. automodule:: nitpick.constants
+   :members:
+   :undoc-members:
+   :show-inheritance: