Fix public comment & docs update (#5)

Author: hakancelikdev

.github/workflows/build-docs.yml

@@ -0,0 +1,24 @@
+name: build-docs
+on:
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - uses: actions/setup-python@v2.1.4
+        with:
+          python-version: "3.8"
+          architecture: "x64"
+
+      - name: Install  Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .[docs]
+
+      - name: Build Docs
+        run: |
+          git fetch --all 
+          mkdocs gh-deploy -m "Update Docs" --remote-branch gh-pages

.github/workflows/tests.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install  Dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pytest==6.2.2 pytest-cov==2.11.1
+          python -m pip install -e .[dev]
 
       - name: Test with pytest
         run: |

docs/_coverpage.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 24/07/2021
+
+- [Version 0.2.0 by @hakancelik96](https://github.com/hakancelik96/pyall/pull/5)
+  - Docs update
+  - pyall: public ( bug fix )
+
 ## [0.1.0] - 11/04/2021
 
 - [Version V0.1.0 by @hakancelik96](https://github.com/hakancelik96/pyall/pull/1)

docs/_sidebar.md

@@ -49,8 +49,8 @@ If all tests pass.
 ## The final step
 
 After adding a new feature or fixing a bug please report your change to
-[CHANGELOG.md](CHANGELOG.md) and write your name, GitHub address, and email in the
-[AUTHORS.md](AUTHORS.md) file in alphabetical order.
+[CHANGELOG.md](changelog.md) and write your name, GitHub address, and email in the
+[AUTHORS.md](authors.md) file in alphabetical order.
 
 ### Commit Messages
 

docs/AUTHORS.md renamed to docs/authors.md

@@ -28,6 +28,117 @@ packaging tools. We recommend installing the latest stable release from PyPI wit
 $ pip install pyall
 ```
 
+## Sources
+
+> (optional: default `the file directory you are in`) -> `Path(".")`
+
+You can give as many file or directory paths as you want.
+
+**Usage**
+
+- `$ pyall`
+- `$ pyall example`
+- `$ pyall example example1 example2 example/example.py`
+
+## Include
+
+> (optional: default '\\.(py)$') file include pattern
+
+**Usage**
+
+- `$ pyall --include mypackage`
+- `$ pyall --include "mypackage|tests`
+
+## Exclude
+
+> (optional: default '^$') file exclude pattern
+
+**Usage**
+
+- `$ pyall --exclude __init__.py`
+- `$ pyall --exclude "__init__.py|tests|.tox`
+
+## Default public states.
+
+- Variables are defined with an upper letters.
+
+```python
+VARIABLE = "variable"
+
+PUBLIC_VARIABLE = "variable"
+```
+
+- functions, or classes that do not begin with an underscore are public.
+
+```python
+
+def function():
+  ...
+
+
+class Klass:
+  ...
+
+```
+
+### Make It not-public
+
+Write the comment `# pyall: not-public` on the line containing the variable, function
+and class that you want to make public.
+
+```python
+
+VARIABLE = "variable" # pyall: not-public
+
+def function(): # pyall: not-public
+  ...
+
+class Klass: # pyall: not-public
+  ...
+
+```
+
+## Default not-public states.
+
+- The variable is not public unless all characters are uppercase.
+
+```python
+variable = "variable"
+
+Variable = "variable"
+
+```
+
+- Variables, functions, and classes that begin with an underscore are not public.
+
+```python
+_VARIABLE = "variable"
+
+def _function():
+  ...
+
+class _Klass:
+  ...
+
+```
+
+### Make It Public
+
+Write the comment `# pyall: public` on the line containing the variable, function and
+class that you want to make public.
+
+```python
+
+_variable = "variable" # pyall: public
+
+def _function(): # pyall: public
+  ...
+
+class _Klass: # pyall: public
+  ...
+
+```
+
 ### Command line options
 
 You can list many options by running pyall --help
@@ -66,3 +177,49 @@ repos:
       - id: pyall
         args: [--refactor]
 ```
+
+## Examples
+
+**/example.py**
+
+```python
+
+PUBLIC_VARIABLE = "variable"
+
+def _not_public_function():
+  ...
+
+class PublicKlass:
+  ...
+
+
+class _NotPublicKlass:
+  ...
+
+
+public_variable = "variable" # pyall: public
+
+```
+
+> Command line: `$ pyall /example.py -r`
+
+**Output**
+
+```python
+__all__ = ['PUBLIC_VARIABLE', 'PublicKlass', 'public_variable']
+
+PUBLIC_VARIABLE = "variable"
+
+def _not_public_function():
+  ...
+
+class PublicKlass:
+  ...
+
+
+class _NotPublicKlass:
+  ...
+
+
+public_variable = "variable" # pyall: public
+```