https://github.com/lorien/sandbox

https://github.com/lorien/sandbox

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lorien/sandbox
• Owner: lorien
• License: mit
• Created: 2025-08-31T17:10:25.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2025-09-10T14:10:04.000Z (4 months ago)
• Last Synced: 2025-09-10T17:52:28.314Z (4 months ago)
• Language: Makefile
• Size: 32.2 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Default Python Project Template README

[![Test Status](https://github.com/lorien/sandbox/actions/workflows/test.yml/badge.svg)](https://github.com/lorien/sandbox/actions/workflows/test.yml)

[![Code Quality](https://github.com/lorien/sandbox/actions/workflows/check.yml/badge.svg)](https://github.com/lorien/sandbox/actions/workflows/test.yml)

[![Type Check](https://github.com/lorien/sandbox/actions/workflows/mypy.yml/badge.svg)](https://github.com/lorien/sandbox/actions/workflows/mypy.yml)

[![Test Coverage Status](https://coveralls.io/repos/github/lorien/sandbox/badge.svg)](https://coveralls.io/github/lorien/sandbox)

[![Documentation Status](https://readthedocs.org/projects/sandbox/badge/?version=latest)](https://sandbox.readthedocs.org)

This project is created with cookiecutter using template located at https://github.com/lorien/pyproject

To create another project from this template, run the command "cookiecutter gh:lorien/pyproject"

## Initial Project Setup

To create virtual environment and install all dependencies run: `make init`

You can change dependencies in "requirements\_dev.txt" file

# Type checking and linters

Run command "make check" to run mypy, pylint, ruff and linters on your files. Do not forget

to update FILES\_CHECK\_MYPY and FILES\_CHECK\_ALL in Makefile to include all packages and modules

you want to check.

## Database

By default the project is configured to use MongoDB. To change MongoDB connection settings update "var/config.yml" file.

## Scripts

Command line scripts are stored in "script/" directory and can be launched with `run`

command which is provided by "runscript" package.

Example. You have "script/foo.py" file. If you run console command "run foo", the runscript

framework will run `main()` function from "script/foo.py" file.

## Community

Telegram English chat: [https://t.me/grablab](https://t.me/grablab)

Telegram Russian chat: [https://t.me/grablab\_ru](https://t.me/grablab_ru)