Skip to content

Commit b9d50b5

Browse files
Tim-ats-dTim-ats-d
authored
Merge pull request #8 from Tim-ats-d/dev
Visual-dialog 0.7
2 parents b9ca737 + b967aaf commit b9d50b5

32 files changed

+1663
-796
lines changed

‎.gitignore

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,132 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
1131
.vscode
2132
.idea

‎CONTRIBUTING.md

Lines changed: 58 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,89 @@
33

44
## Setup your development environment
55

6-
You need:
7-
* `Python3.6`: you can install it by following [Python3's documentation](https://www.python.org/downloads/).
8-
* `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.
6+
You need [all requirements](README#requirements).
97

108
## Branches
119

12-
* main : stable releases.
10+
* `main` : stable releases.
11+
* `dev` : beta releases.
1312

1413
To fix a minor problem or add new features create a new branch in this form: `username-dev`.
15-
Please test your code with `Python3.6` version before **pull request** to be sure not to break compatability.
14+
Please push on the `dev` branch, any pull request on the `main` branch will be refused.
1615

17-
## Download
16+
## Conventions
1817

19-
Download projet:
20-
```bash
21-
git clone https://github.com/Tim-ats-d/Visual-dialog
22-
```
18+
When you make a pull request make sure to:
2319

24-
Install Visual-dialog using `pip`:
25-
```bash
26-
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog
27-
```
28-
or update lib to the latest version:
29-
```bash
30-
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
20+
* Test your code with `Python3.7` to be sure not to break compatability.
21+
* 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 .
22+
* Document your code with [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) if you add new functionality.
23+
24+
If you add a feature that changes the API, notify it explicitly.
25+
26+
## Download
27+
28+
Download the `dev` branch of the project and install dev release:
29+
```sh
30+
git clone -b dev https://github.com/Tim-ats-d/Visual-dialog.git
31+
cd Visual-dialog
32+
pip install .
3133
```
3234
The list of versions and their changelogs can be found [here](https://github.com/Tim-ats-d/Visual-dialog/releases/).
3335

3436
## Repository Structure
3537

3638
The following snippet describes Visual-dialog's repository structure.
39+
This tree does not contain a description of all the files in the repository, only the most relevant ones
3740

3841
```text
3942
.
4043
├── .github/
41-
| Contains Github specific files such as actions definitions and issue templates.
44+
│ Contains Github specific files such as actions definitions and issue templates.
4245
│
4346
├── doc/
44-
| Contains documentation.
47+
│ Contains the files related to the documentation.
48+
│ │
49+
│ ├── source/
50+
│ │ Contains images used in documentation.
51+
│ │ │
52+
│ │ ├── images/
53+
│ │ │ Contains images used in documentation.
54+
│ │ │
55+
│ │ ├── conf.py
56+
│ │ │ Sphinx's configuration file.
57+
│ │ │
58+
│ │ ├── index.rst
59+
│ │ │ Documentation home page.
60+
│ │ │
61+
│ │ └── visualdialog.rst
62+
│ │ Documentation of all the public classes and methods in Visual-dialog.
4563
│ │
46-
│ ├── examples/
47-
│ │ Contains several examples of how to use Visual-dialog.
64+
│ ├── make.bat
65+
│ │ To generate documentation on Windows.
4866
│ │
49-
│ └── documentation.md
50-
│ Documentation of public API (coming soon).
67+
│ └── Makefile
68+
│ To generate documentation on GNU/Linux or MacOS.
69+
│
70+
├── examples/
71+
│ Contains several examples of use cases of Visual-dialog.
72+
│
73+
├── tests/
74+
│ Contains tests for debugging libraries.
5175
│
5276
├── visualdialog/
53-
| Source for Visual-dialog's library.
77+
│ Source for Visual-dialog's library.
78+
│ │
79+
│ ├── __init__.py
80+
│ │
81+
│ ├── box.py
82+
│ │ Contains the parent class TextBox which serves as a basis for the implementation of the other classes.
5483
│ │
55-
| ├── __init__.py
84+
│ ├── dialog.py
85+
│ │ Contains the DialogBox class, which is the main class of the library.
5686
│ │
57-
| └── core.py
58-
| Contains Visual-dialog's core functionnalities.
87+
│ └── utils.py
88+
│ Contains the classes and functions used but not related to the libriarie.
5989
│
6090
├── LICENSE
6191
│
@@ -68,5 +98,5 @@ The following snippet describes Visual-dialog's repository structure.
6898
├── README.md
6999
│
70100
└── setup.py
71-
Installation of the library.
101+
Installation of the library.
72102
```

0 commit comments

Comments
 (0)