chore: Use poetry (WIP)

Author: pawamoy

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

.gitignore

@@ -1,10 +1,11 @@
 .idea/
-Pipfile.lock
-examples/
-output.md
 __pycache__/
-src/dist/
-build/
+*.py[cod]
 dist/
 *.egg-info/
-*.pyc
+build/
+.coverage
+tests/tmp/*
+!tests/tmp/.gitkeep
+pip-wheel-metadata/
+.pytest_cache/

.gitlab-ci.yml

@@ -0,0 +1,77 @@
+variables:
+    PIP_CACHE_DIR: "${CI_PROJECT_DIR}/.cache/pip"
+
+cache:
+  key: "${CI_JOB_NAME}"
+  paths:
+    - .cache/pip
+    - .venv
+
+stages:
+  - quality
+  - tests
+
+.quality-template: &quality
+  image: python:3.6
+  stage: quality
+
+check-black:
+  <<: *quality
+  before_script:
+    - pip install black
+  script: black --check src/ tests/
+
+check-isort:
+  <<: *quality
+  before_script:
+    - pip install isort[pyproject]
+  script: isort -c -rc src/ tests/
+
+check-flake8:
+  <<: *quality
+  before_script:
+    - pip install flake8
+  script: flake8 src/ tests/
+
+check-bandit:
+  <<: *quality
+  before_script:
+    - pip install bandit
+  script: bandit -r src/
+
+check-safety:
+  <<: *quality
+  before_script:
+    - apt-get update
+    - apt-get install -y python-enchant
+    - pip install poetry
+    - poetry config settings.virtualenvs.in-project true
+    - poetry install -vv
+    - poetry --version
+  script: make check-safety
+
+.test-template: &test
+  stage: tests
+  before_script:
+    - apt-get update
+    - apt-get install -y python-enchant
+    - apt-get install -y aria2
+    - pip install poetry
+    - poetry config settings.virtualenvs.in-project true
+    - poetry install -vv
+    - poetry --version
+  script: poetry run pytest -v
+
+python3.6:
+  <<: *test
+  image: python:3.6
+
+python3.7:
+  <<: *test
+  image: python:3.7
+
+python3.8:
+  <<: *test
+  image: python:3.8-rc
+  allow_failure: true
+

.python-version

@@ -0,0 +1 @@
+3.6.8

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pawamoy@pm.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+Contributions are welcome, and they are greatly appreciated!
+
+Every little bit helps, and credit will always be given.
+
+## Types of Contributions
+
+### Bug Reports, Feature Requests, and Feedback
+Create a new [GitHub issue][1] or [GitLab issue][2]! Try to be as descriptive as possible.
+
+### Bug Fixes, New Features and Documentation
+This project is developed using [`poetry`](https://github.com/sdispater/poetry).
+Follow the recommended installation method:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
+```
+
+1. Fork the repository [on GitHub][3] or [on GitLab][4];
+1. Clone it on your machine;
+1. Go into the directory, and run `poetry install` to setup the development environment;
+1. Create a new branch with `git checkout -b bug-fix-or-feature-name`;
+1. Code!
+1. **Write tests. Run them all.** The commands to run the tests are:
+   ```bash
+   poetry run pytest  # to run all tests sequentially
+   poetry run pytest -v  # to print one test per line
+   poetry run pytest -n 4  # to run tests in parallel (4 workers)
+   poetry run pytest tests/test_api.py  # to run tests in a specific file
+   ```
+  
+   `pytest` provides the `-k` option to select tests based on their names:
+   
+   ```bash
+   poetry run pytest -k "api and remove"
+   poetry run pytest -k "utils or stats"
+   ``` 
+   
+   See the [documentation for the `-k` option][5] for more examples.
+
+7. When the tests pass, commit;
+8. Push;
+9. ...and finally, create a new [pull request][6] / [merge request][7]!
+   Make sure to follow the guidelines.
+
+## Merge/Pull Request Guidelines
+Make sure to have atomic commits and contextual commit messages!
+
+[Check out this awesome blog post by Chris Beams for more information.][8]
+
+[1]: https://github.com/pawamoy/aria2p/issues/new
+[2]: https://gitlab.com/pawamoy/aria2p/issues/new
+[3]: https://github.com/pawamoy/aria2p
+[4]: https://gitlab.com/pawamoy/aria2p
+[5]: https://docs.pytest.org/en/latest/example/markers.html#using-k-expr-to-select-tests-based-on-their-name
+[6]: https://github.com/pawamoy/aria2p/compare
+[7]: https://gitlab.com/pawamoy/aria2p/compare
+[8]: http://chris.beams.io/posts/git-commit/

CREDITS.md

@@ -0,0 +1,69 @@
+# Credits
+These projects were used to build `aria2p`. **Thank you!**
+
+[![`python`](https://www.vectorlogo.zone/logos/python/python-ar21.svg)](https://www.python.org/) |
+[`poetry`](https://poetry.eustace.io/)
+
+### Direct dependencies
+[`flake8`](https://gitlab.com/pycqa/flake8) |
+[`ipython`](https://ipython.org) |
+[`pytest`](https://docs.pytest.org/en/latest/) |
+[`pytest-cov`](https://github.com/pytest-dev/pytest-cov) |
+[`pytest-sugar`](http://pivotfinland.com/pytest-sugar/) |
+[`pytest-xdist`](https://github.com/pytest-dev/pytest-xdist) |
+[`recommonmark`](https://github.com/rtfd/recommonmark) |
+[`requests`](http://python-requests.org) |
+[`responses`](https://github.com/getsentry/responses) |
+[`Sphinx`](http://sphinx-doc.org/) |
+[`sphinx-rtd-theme`](https://github.com/rtfd/sphinx_rtd_theme/) |
+[`sphinxcontrib-spelling`](https://github.com/sphinx-contrib/spelling)
+
+### Indirect dependencies
+[`alabaster`](https://alabaster.readthedocs.io) |
+[`apipkg`](https://github.com/pytest-dev/apipkg) |
+[`atomicwrites`](https://github.com/untitaker/python-atomicwrites) |
+[`attrs`](https://www.attrs.org/) |
+[`Babel`](http://babel.pocoo.org/) |
+[`backcall`](https://github.com/takluyver/backcall) |
+[`certifi`](https://certifi.io/) |
+[`chardet`](https://github.com/chardet/chardet) |
+[![CommonMark](https://www.vectorlogo.zone/logos/commonmark/commonmark-ar21.svg)](https://github.com/rolandshoemaker/CommonMark-py) |
+[`coverage`](https://bitbucket.org/ned/coveragepy) |
+[`decorator`](https://github.com/micheles/decorator) |
+[`docutils`](http://docutils.sourceforge.net/) |
+[`execnet`](http://codespeak.net/execnet) |
+[`idna`](https://github.com/kjd/idna) |
+[`imagesize`](https://github.com/shibukawa/imagesize_py) |
+[`ipython-genutils`](http://ipython.org) |
+[`jedi`](https://github.com/davidhalter/jedi) |
+[![jinja2](https://www.vectorlogo.zone/logos/pocoo_jinja/pocoo_jinja-ar21.svg)](http://jinja.pocoo.org/?utm_source=vectorlogozone&utm_medium=referrer) | 
+[`MarkupSafe`](https://www.palletsprojects.com/p/markupsafe/) |
+[`mccabe`](https://github.com/pycqa/mccabe) |
+[`more-itertools`](https://github.com/erikrose/more-itertools) |
+[`packaging`](https://github.com/pypa/packaging) |
+[`parso`](https://github.com/davidhalter/parso) |
+[`pexpect`](https://pexpect.readthedocs.io/) |
+[`pickleshare`](https://github.com/pickleshare/pickleshare) |
+[`pluggy`](https://github.com/pytest-dev/pluggy) |
+[`prompt-toolkit`](https://github.com/jonathanslenders/python-prompt-toolkit) |
+[`ptyprocess`](https://github.com/pexpect/ptyprocess) |
+[`py`](http://py.readthedocs.io/) |
+[`pycodestyle`](https://pycodestyle.readthedocs.io/) |
+[`pyenchant`](https://pythonhosted.org/pyenchant/) |
+[`pyflakes`](https://github.com/PyCQA/pyflakes) |
+[`Pygments`](http://pygments.org/) |
+[`pyparsing`](https://github.com/pyparsing/pyparsing/) |
+[`pytest-forked`](https://github.com/pytest-dev/pytest-forked) |
+[`pytz`](http://pythonhosted.org/pytz) |
+[`six`](https://github.com/benjaminp/six) |
+[`snowballstemmer`](https://github.com/shibukawa/snowball_py) |
+[`sphinxcontrib-websupport`](http://sphinx-doc.org/) |
+[`termcolor`](http://pypi.python.org/pypi/termcolor) |
+[`traitlets`](http://ipython.org) |
+[`urllib3`](https://urllib3.readthedocs.io/) |
+[`wcwidth`](https://github.com/jquast/wcwidth)
+
+**[More credits from the author](http://pawamoy.github.io/credits/)**
+
+*See one of your project without the logo? Make sure it's available on [VectorLogoZone](https://www.vectorlogo.zone/)
+([GitHub repo](https://github.com/VectorLogoZone/vectorlogozone)) and open an issue or send a pull/merge request!*

Makefile

@@ -0,0 +1,67 @@
+.PHONY: help
+.PHONY: docs
+.PHONY: test-py36
+.PHONY: test-py37
+.PHONY: clean
+.PHONY: clean-tests
+.DEFAULT_GOAL := help
+
+help:  ## Print this help.
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
+
+readme: README.md  ## Regenerate README.md.
+	poetry run ./scripts/gen-readme-data.py | \
+		poetry run jinja2 --format=json scripts/templates/README.md > README.md
+
+docs:  ## Build the documentation locally.
+	poetry run sphinx-build -E -b html docs build/docs
+
+check: check-bandit check-black check-flake8 check-isort check-safety check-ports check-docs-spelling  ## Check it all!
+
+update-spelling-wordlist:  ## Update the spelling word list.
+	scripts/update-spelling-wordlist.sh
+
+check-docs-spelling: update-spelling-wordlist  ## Check spelling in the documentation.
+	scripts/check-docs-spelling.sh
+
+check-black:  ## Check if code is formatted nicely using black.
+	poetry run black --check src/ tests/ docs/conf.py
+
+check-isort:  ## Check if imports are correctly ordered using isort.
+	poetry run isort -c -rc src/ tests/ docs/conf.py
+
+check-flake8:  ## Check for general warnings in code using flake8.
+	poetry run flake8 src/ tests/
+
+check-bandit:  ## Check for security warnings in code using bandit.
+	poetry run bandit -r src/
+
+check-safety:  ## Check for vulnerabilities in dependencies using safety.
+	poetry run pip freeze 2>/dev/null | \
+		grep -v aria2p | \
+		poetry run safety check --stdin --full-report 2>/dev/null
+
+check-ports:  ## Check if the ports used in the tests are all unique.
+	scripts/check-ports.sh
+
+run-black:  ## Lint the code using black.
+	poetry run black src/ tests/ docs/conf.py
+
+run-isort:  ## Sort the imports using isort.
+	poetry run isort -y -rc src/ tests/ docs/conf.py
+
+lint: run-black run-isort  ## Run linting tools on the code.
+
+clean-tests:  ## Delete temporary tests files.
+	@rm -rf tests/tmp/* 2>/dev/null
+
+clean: clean-tests  ## Delete temporary files.
+	@rm -rf build 2>/dev/null
+	@rm -rf dist 2>/dev/null
+	@rm -rf src/aria2p.egg-info 2>/dev/null
+	@rm -rf .coverage* 2>/dev/null
+	@rm -rf .pytest_cache 2>/dev/null
+	@rm -rf pip-wheel-metadata 2>/dev/null
+
+test: check-ports clean-tests  ## Run the tests using pytest.
+	poetry run pytest -n6 2>/dev/null