Docs (#5)

* Update: readme plastic ~> flat-square. * Reordering. * Reordering. * Reordering. * Recolor pycln docs. * format. * Update README.md * Init docs/README.md * Black ~> stable. * Continue: README.md * Update: .pre-commit-config (move configs to files). * Specify black version. * Run pre-commit
hadialqattan · Oct 2, 2020 · 531d675 · 531d675
1 parent 0560f81
commit 531d675
Show file tree

Hide file tree

Showing 17 changed files with 1,747 additions and 894 deletions.
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 88
+max-doc-length = 88
+extend-ignore = E203, W503
+ignore-names= *visit_*, *leave_*
diff --git a/.github/ci_status.py b/.github/ci_status.py
@@ -58,4 +58,4 @@ def main() -> int:
 
 
 if __name__ == "__main__":
-    exit(main())
+    exit(main())  # pragma: nocover
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -34,14 +34,7 @@ repos:
     hooks:
       - id: isort
         files: "\\.(py)$"
-        args:
-          [
-            --line-length=88,
-            --multi-line=3,
-            --force-grid-wrap=0,
-            --trailing-comma,
-            --use-parentheses,
-          ]
+        args: [--settings-path=pyproject.toml]
 
   - repo: https://github.com/myint/docformatter
     rev: v1.3.1
@@ -53,25 +46,13 @@ repos:
     rev: 20.8b1
     hooks:
       - id: black
-        args: [--line-length=88]
-
-  - repo: https://github.com/asottile/blacken-docs
-    rev: v1.8.0
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==20.8b1]
+        args: [--config=pyproject.toml]
 
   - repo: https://gitlab.com/pycqa/flake8
     rev: "3.8.3"
     hooks:
       - id: flake8
         additional_dependencies: [pep8-naming]
-        args:
-          [
-            --max-line-length=88,
-            --max-doc-length=88,
-            "--ignore-names=*visit_*,*leave_*",
-          ]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.782

diff --git a/README.md b/README.md
@@ -3,29 +3,35 @@
     <quote>A formatter for finding and removing unused import statements.</quote>
 </p>
 
-<p align="center"><a href="https://github.com/hadialqattan/pycln/actions?query=workflow%3ACI"><img src="https://github.com/hadialqattan/pycln/workflows/CI/badge.svg?branch=master" alt="CI"></a>
-<a href="https://hadialqattan.github.io/pycln"><img src="https://img.shields.io/badge/For%20More%20Information%20See-Pycln%20Docs-34495e.svg" alt="Code style: prettier"></a>
-<a href="https://github.com/hadialqattan/pycln/actions?query=workflow%3ACD"><img src="https://github.com/hadialqattan/pycln/workflows/CD/badge.svg?branch=master" alt="CD"></a></p>
-
-<p align="center"><img src="https://img.shields.io/pypi/pyversions/pycln" alt="PYPI - Python Version">
-<a href="https://pypi.org/project/pycln/"><img src="https://img.shields.io/pypi/v/pycln" alt="PYPI - Pycln Version"></a></p>
-
-<p align="center"><a href="https://www.codacy.com/manual/hadialqattan/pycln/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=hadialqattan/pycln&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/e7c6c290c3c149e484634ac1905800d6" alt="Codacy Badge"></a>
-<a href="https://codecov.io/gh/hadialqattan/pycln"><img src="https://codecov.io/gh/hadialqattan/pycln/branch/master/graph/badge.svg?token=VVYBDCZPHR" alt="Codecov"></a>
-<a href="https://codeclimate.com/github/hadialqattan/pycln/maintainability"><img src="https://api.codeclimate.com/v1/badges/38ec82d916c0707149aa/maintainability" alt="Maintainability"></a></p>
-
-<p align="center"><a href="https://docutils.sourceforge.io/rst.html"><img src="https://img.shields.io/badge/docstrings-reStructuredText-gree.svg" alt="Docstrings: reStructuredText"></a>
-<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
-<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code%20style-prettier-ff69b4.svg" alt="Code style: prettier"></a></p>
+<p align="center">
+    <a href="https://hadialqattan.github.io/pycln"><img src="https://img.shields.io/badge/For%20More%20Information%20See-Pycln%20Docs-B5FFB3.svg?style=flat-square" alt="Code style: prettier"></a>
+    <a href="https://github.com/hadialqattan/pycln/actions?query=workflow%3ACI"><img src="https://img.shields.io/github/workflow/status/hadialqattan/pycln/CI/master?label=CI&logo=github&style=flat-square" alt="CI"></a>
+    <a href="https://github.com/hadialqattan/pycln/actions?query=workflow%3ACD"><img src="https://img.shields.io/github/workflow/status/hadialqattan/pycln/CD/master?label=CD&logo=github&style=flat-square" alt="CD"></a>
+    <a href="https://www.codacy.com/manual/hadialqattan/pycln/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=hadialqattan/pycln&amp;utm_campaign=Badge_Grade"><img src="https://img.shields.io/codacy/grade/e7c6c290c3c149e484634ac1905800d6/master?style=flat-square" alt="Codacy Badge"></a>
+    <a href="https://codecov.io/gh/hadialqattan/pycln"><img src="https://img.shields.io/codecov/c/gh/hadialqattan/pycln/master?token=VVYBDCZPHR&style=flat-square" alt="Codecov"></a>
+    <a href="https://codeclimate.com/github/hadialqattan/pycln/maintainability"><img src="https://img.shields.io/codeclimate/maintainability/hadialqattan/pycln?style=flat-square" alt="Maintainability"></a>
+</p>
 
-<p align="center"><a href="https://github.com/hadialqattan/pycln/fork"><img src="https://img.shields.io/github/forks/hadialqattan/pycln" alt="Forks"></a>
-<a href="https://github.com/hadialqattan/pycln/stargazers"><img src="https://img.shields.io/github/stars/hadialqattan/pycln" alt="Stars"></a>
-<a href="https://github.com/hadialqattan/pycln/issues"><img src="https://img.shields.io/github/issues/hadialqattan/pycln" alt="Issues"></a>
-<a href="https://github.com/hadialqattan/pycln/pulls"><img src="https://img.shields.io/github/issues-pr/hadialqattan/pycln" alt="Pull Requests"></a></p>
+<p align="center">
+    <img src="https://img.shields.io/pypi/pyversions/pycln?style=flat-square" alt="PYPI - Python Version">
+    <a href="https://pypi.org/project/pycln/"><img src="https://img.shields.io/pypi/v/pycln?style=flat-square" alt="PYPI - Pycln Version"></a>
+    <a href="https://pypi.org/project/pycln/"><img src="https://img.shields.io/pypi/dm/pycln?color=dark-green&style=flat-square" alt="Downloads"></a>
+    <a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fhadialqattan%2Fpycln&count_bg=%2344CC10&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true"/></a>
+    <a href="_blank"><img src="https://img.shields.io/tokei/lines/github.com/hadialqattan/pycln?style=flat-square" alt="Lines Of Code"></a>
+</p>
 
-<p align="center"><a href="https://github.com/hadialqattan/pycln/graphs/contributors"><img src="https://img.shields.io/github/contributors/hadialqattan/pycln" alt="Contributors"></a>
-<a href="https://github.com/hadialqattan/pycln/commits/master"><img src="https://img.shields.io/github/last-commit/hadialqattan/pycln.svg" alt="Last Commit"></a>
-<a href="https://github.com/hadialqattan/pycln/blob/master/LICENSE"><img src="https://img.shields.io/github/license/hadialqattan/pycln.svg" alt="License"></a></p>
+<p align="center">
+    <a href="https://github.com/hadialqattan/pycln/fork"><img src="https://img.shields.io/github/forks/hadialqattan/pycln?style=flat-square" alt="Forks"></a>
+    <a href="https://github.com/hadialqattan/pycln/stargazers"><img src="https://img.shields.io/github/stars/hadialqattan/pycln?style=flat-square" alt="Stars"></a>
+    <a href="https://github.com/hadialqattan/pycln/issues"><img src="https://img.shields.io/github/issues/hadialqattan/pycln?style=flat-square" alt="Issues"></a>
+    <a href="https://github.com/hadialqattan/pycln/pulls"><img src="https://img.shields.io/github/issues-pr/hadialqattan/pycln?style=flat-square" alt="Pull Requests"></a>
+    <a href="https://github.com/hadialqattan/pycln/graphs/contributors"><img src="https://img.shields.io/github/contributors/hadialqattan/pycln?style=flat-square" alt="Contributors"></a>
+    <a href="https://github.com/hadialqattan/pycln/commits/master"><img src="https://img.shields.io/github/last-commit/hadialqattan/pycln.svg?style=flat-square" alt="Last Commit"></a>
+    <a href="https://github.com/hadialqattan/pycln/blob/master/LICENSE"><img src="https://img.shields.io/github/license/hadialqattan/pycln.svg?color=A31F34&style=flat-square" alt="License"></a>
+</p>
 
-<p align="center"><a href="https://pepy.tech/project/pycln"><img src="https://pepy.tech/badge/pycln" alt="Downloads"></a>
-<a href="_blank"><img src="https://img.shields.io/tokei/lines/github.com/hadialqattan/pycln" alt="Lines Of Code"></a></p>
+<p align="center">
+    <a href="https://docutils.sourceforge.io/rst.html"><img src="https://img.shields.io/badge/docstrings-reStructuredText-gree.svg?style=flat-square" alt="Docstrings: reStructuredText"></a>
+    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="Code style: black"></a>
+    <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code%20style-prettier-ff69b4.svg?style=flat-square" alt="Code style: prettier"></a>
+</p>
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -9,3 +9,12 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 <!-- - [description by @username](https://github.com/hadialqattan/pycln/pull/{pull_number}) -->
 
 ## [Unreleased]
+
+## [0.0.1-alpha.0] - 2020-10-02
+
+### Added
+
+- [First published version](https://pypi.org/project/pycln/), Happy 🍰 Day 2020!
+- [Alpha quality](https://techterms.com/definition/alpha_software).
+- [Semantically versioned](https://semver.org/spec/v2.0.0.html)
+- [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) formatted.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -125,7 +125,7 @@ After adding a new feature or fixing a bug please:
 - Report your changes to [CHANGELOG.md](CHANGELOG).
 - Write your name, GitHub username, and email on the [AUTHORS.md](AUTHORS) file.
 
-## Q & A
+## FAQ
 
 ### How To Update My Local Forked Repository?
 
@@ -147,6 +147,23 @@ After adding a new feature or fixing a bug please:
    $ git push origin {branch_name} --force
    ```
 
+### How Can I See My Doc Updates Locally?
+
+Once you have [npm installed](https://www.npmjs.com/get-npm):
+
+1. Install [docsify-cli](https://www.npmjs.com/package/docsify-cli) via
+   [npm](https://www.npmjs.com/) globally:
+
+   ```bash
+   $ npm i docsify-cli -g
+   ```
+
+2. On the Pycln root directory run:
+
+   ```bash
+   $ docsify serve docs/ --open
+   ```
+
 ### How Can I Run Pycln Scripts Using Windows?
 
 - You can install [Git for Windows](https://gitforwindows.org/) to use the bash
@@ -155,7 +172,7 @@ After adding a new feature or fixing a bug please:
   [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 - Or you can perform any script manually by convering it to a Windows commands.
 
-### License
+## License
 
 Pycln is MIT licensed, as found in the
 [LICENSE](https://github.com/hadialqattan/pycln/tree/master/LICENSE) file.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -58,4 +58,4 @@ def main() -> int:


		if __name__ == "__main__":
		exit(main())
		exit(main()) # pragma: nocover