Visual-dialog 0.7

.gitignore

@@ -1,2 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
 .vscode
 .idea

CONTRIBUTING.md

@@ -3,59 +3,89 @@
 
 ## Setup your development environment
 
-You need:
-* `Python3.6`: you can install it by following [Python3's documentation](https://www.python.org/downloads/).
-* `curses`: available in standard library of `Python` but it doesn't work out-of-the-box on Windows. See [this](https://www.devdungeon.com/content/curses-windows-python) explanations to install `curses` on Windows.
+You need [all requirements](README#requirements).
 
 ## Branches
 
-* main : stable releases.
+* `main` : stable releases.
+* `dev` : beta releases.
 
 To fix a minor problem or add new features create a new branch in this form: `username-dev`.
-Please test your code with `Python3.6` version before **pull request** to be sure not to break compatability.
+Please push on the `dev` branch, any pull request on the `main` branch will be refused.
 
-## Download
+## Conventions
 
-Download projet:
-```bash
-git clone https://github.com/Tim-ats-d/Visual-dialog
-```
+When you make a pull request make sure to:
 
-Install Visual-dialog using `pip`:
-```bash
-python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog
-```
-or update lib to the latest version:
-```bash
-python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
+* Test your code with `Python3.7` to be sure not to break compatability.
+* Format your code according [PEP 8](https://www.python.org/dev/peps/pep-0008/). [PEP8 Check](https://github.com/quentinguidee/actions-pep8) will ensure that your code is correctly formatted .
+* Document your code with [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) if you add new functionality.
+
+If you add a feature that changes the API, notify it explicitly.
+
+## Download
+
+Download the `dev` branch of the project and install dev release:
+```sh
+git clone -b dev https://github.com/Tim-ats-d/Visual-dialog.git
+cd Visual-dialog
+pip install .
 ```
 The list of versions and their changelogs can be found [here](https://github.com/Tim-ats-d/Visual-dialog/releases/).
 
 ## Repository Structure
 
 The following snippet describes Visual-dialog's repository structure.
+This tree does not contain a description of all the files in the repository, only the most relevant ones
 
 ```text
 .
 ├── .github/
-|   Contains Github specific files such as actions definitions and issue templates.
+│   Contains Github specific files such as actions definitions and issue templates.
 │
 ├── doc/
-|   Contains documentation.
+│   Contains the files related to the documentation.
+│   │
+│   ├── source/
+│   │   Contains images used in documentation.
+│   │   │
+│   │   ├── images/
+│   │   │   Contains images used in documentation.
+│   │   │
+│   │   ├── conf.py
+│   │   │   Sphinx's configuration file.
+│   │   │
+│   │   ├── index.rst
+│   │   │   Documentation home page.
+│   │   │
+│   │   └── visualdialog.rst
+│   │       Documentation of all the public classes and methods in Visual-dialog.
 │   │
-│   ├── examples/
-│   │   Contains several examples of how to use Visual-dialog.
+│   ├── make.bat
+│   │   To generate documentation on Windows.
 │   │
-│   └── documentation.md
-│       Documentation of public API (coming soon).
+│   └── Makefile
+│       To generate documentation on GNU/Linux or MacOS.
+│
+├── examples/
+│   Contains several examples of use cases of Visual-dialog.
+│
+├── tests/
+│   Contains tests for debugging libraries.
 │
 ├── visualdialog/
-|   Source for Visual-dialog's library.
+│   Source for Visual-dialog's library.
+│   │
+│   ├── __init__.py
+│   │
+│   ├── box.py
+│   │   Contains the parent class TextBox which serves as a basis for the implementation of the other classes.
 │   │
-|   ├── __init__.py
+│   ├── dialog.py
+│   │   Contains the DialogBox class, which is the main class of the library.
 │   │
-|   └── core.py
-|       Contains Visual-dialog's core functionnalities.
+│   └── utils.py
+│       Contains the classes and functions used but not related to the libriarie.
 │
 ├── LICENSE
 │
@@ -68,5 +98,5 @@ The following snippet describes Visual-dialog's repository structure.
 ├── README.md
 │
 └── setup.py
-    Installation of the library.
+   Installation of the library.
 ```