https://github.com/preocts/eggmenu
WIP
https://github.com/preocts/eggmenu
Last synced: about 1 year ago
JSON representation
WIP
- Host: GitHub
- URL: https://github.com/preocts/eggmenu
- Owner: Preocts
- License: mit
- Created: 2021-06-14T02:46:03.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-04-07T01:56:16.000Z (about 4 years ago)
- Last Synced: 2025-03-16T23:46:14.235Z (about 1 year ago)
- Language: Python
- Size: 52.7 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/eggmenu/main)
# eggmenu
Module Description
### Requirements
- Python >= 3.6
## 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/[MODULE_NAME]
$ cd [MODULE_NAME]
```
Create and activate `venv`:
```bash
$ python3 -m venv venv
$ . venv/bin/activate
```
Your command prompt should now have a `(venv)` prefix on it.
Install editable library and development requirements:
```bash
(venv) $ pip install -r requirements-dev.txt
(venv) $ pip install --editable .
```
Run tests
```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