https://github.com/preocts/pydis_summerjam21_qual
Summer Jam '21 qualifier for Python Discord
https://github.com/preocts/pydis_summerjam21_qual
Last synced: about 1 year ago
JSON representation
Summer Jam '21 qualifier for Python Discord
- Host: GitHub
- URL: https://github.com/preocts/pydis_summerjam21_qual
- Owner: Preocts
- License: mit
- Created: 2021-06-22T01:02:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-02T20:51:29.000Z (almost 5 years ago)
- Last Synced: 2025-03-16T23:46:14.805Z (about 1 year ago)
- Language: Python
- Size: 31.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/psf/black)
[](https://github.com/pre-commit/pre-commit)
[](https://results.pre-commit.ci/latest/github/Preocts/pydis_summerjam21_qual/main)
# pydis_summerjam21_qual
Summer Jam '21 qualifier for Python Discord
Qualified
[https://github.com/python-discord/cj8-qualifier](https://github.com/python-discord/cj8-qualifier)
### Requirements
- Python == 3.9.5
## Local developer installation
It is **highly** recommended to use a `venv` for installation. Leveraging a `venv` will ensure the installed dependency files will not impact other python projects or system level requirements.
The instruction below make use of a bash shell and a Makefile. All commands should be able to be run individually of your shell does not support `make`
Clone this repo and enter root directory of repo:
```bash
$ git clone https://github.com/Preocts/pydis_summerjam21_qual
$ cd pydis_summerjam21_qual
```
Create and activate `venv`:
```bash
$ python3.9 -m venv venv
$ . venv/bin/activate
```
Your command prompt should now have a `(venv)` prefix on it.
Install development requirements:
```bash
(venv) $ pip install -r requirements-dev.txt
```
Install pre-commit hooks to local repo:
```bash
(venv) $ pre-commit install
```
Run tests, generate coverage report:
```bash
(venv) $ tox
```
To exit the `venv`:
```bash
(venv) $ deactivate
```
---
### Makefile
This repo has a Makefile with some quality of life scripts if your system supports `make`.
- `update` : Clean all artifacts, update pip, update requirements, install everything
- `clean-pyc` : Deletes python/mypy artifacts
- `clean-tests` : Deletes tox, coverage, and pytest artifacts
- `build-dist` : Build source distribution and wheel distribution