https://github.com/pythonfreecourse/calendar
https://github.com/pythonfreecourse/calendar
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pythonfreecourse/calendar
- Owner: PythonFreeCourse
- License: apache-2.0
- Created: 2021-01-06T17:30:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-22T14:02:32.000Z (about 4 years ago)
- Last Synced: 2025-04-02T15:03:48.995Z (3 months ago)
- Language: Python
- Size: 21.9 MB
- Stars: 34
- Watchers: 1
- Forks: 52
- Open Issues: 117
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PyLander
👋 Welcome to Open Source Calendar built with Python. 🐍
* [Project's objectives](#Project's-objectives)
* [Creating development environment](#creating-development-environment)
* [Contributing](#contributing)
### Project's objectives
1. Develop open source calendar tool using new technics while trying new things.
2. Using Python as main programming language and plain HTML/JS for GUI.
3. Create bonding in our community.
## Creating development environment
### Prerequisites
1. Windows or Linux based system - either [WSL on windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or full blown linux.
2. [Python](https://www.python.org/downloads/release/python-385/)
3. Install python's requirements:
```shell
pip install -r requirements.txt
```
4. Install pre-commit hooks:
```shell
pre-commit install
```
### Running on Windows
```shell
virtualenv env
.\env\Scripts\activate.bat
pip install -r requirements.txt
# Copy app\config.py.example to app\config.py.
# Edit the variables' values.
# Rendering JWT_KEY:
python -c "import secrets; from pathlib import Path; f = Path('app/config.py'); f.write_text(f.read_text().replace('JWT_KEY_PLACEHOLDER', secrets.token_hex(32), 1));"
uvicorn app.main:app --reload
```
### Running on Linux
```shell
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp app/config.py.example app/config.py
# Edit the variables' values.
# Rendering JWT_KEY:
python -c "import secrets; from pathlib import Path; f = Path('app/config.py'); f.write_text(f.read_text().replace('JWT_KEY_PLACEHOLDER', secrets.token_hex(32), 1));"
### Running tox
```shell
# Standard tests: 'coverage' and 'flake8'
tox
# Only flake8 tests
tox -e flake8
# Coverage with html reports
tox -e rep
```
## Contributing
View [contributing guidelines](https://github.com/PythonFreeCourse/calendar/blob/master/CONTRIBUTING.md).