sangge/waka-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: monthly updates for Nov'23

Browse Source
This commit is contained in:
Jovial Joe Jayarson 2023-11-08 11:33:35 +05:30
parent 2aab71918a
commit e644272268
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -163,8 +163,9 @@ cython_debug/
# VSCode # VSCode
.vscode/ .vscode/
# asdf # asdf/rtx
.tool-versions .tool-versions
.rtx.toml
# ruff # ruff
.ruff_cache .ruff_cache

7
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Contributing # Contributing
![python_ver](https://img.shields.io/badge/Python-%3E%3D3.11-blue.svg) ![python_ver](https://img.shields.io/badge/Python-%3E%3D3.12-blue.svg)
> First off, thank you! Please follow along. > First off, thank you! Please follow along.
@ -47,17 +47,18 @@ $ podman-compose -p waka-readme -f ./docker-compose.yml down
1. Inside the cloned folder run the following commands to install dependencies 1. Inside the cloned folder run the following commands to install dependencies
```console ```sh
$ python -m venv .venv $ python -m venv .venv
$ . ./.venv/bin/activate $ . ./.venv/bin/activate
$ python -m pip install . $ python -m pip install .
# ... install decencies ...
``` ```
to activate virtual environment & install dependencies. to activate virtual environment & install dependencies.
2. To test or execute the program in development, run: 2. To test or execute the program in development, run:
```console ```sh
(.venv)$ python -m unittest discover # run tests (.venv)$ python -m unittest discover # run tests
(.venv)$ python -m main --dev # execute program in dev mode (.venv)$ python -m main --dev # execute program in dev mode
``` ```

12
pyproject.toml
View File

@ -15,8 +15,8 @@ classifiers = [
"Programming Language :: Python", "Programming Language :: Python",
"Typing :: Typed", "Typing :: Typed",
] ]
requires-python = ">=3.11" requires-python = ">=3.12"
dependencies = ["faker>=19.11.0", "pygithub>=2.1.1", "requests>=2.31.0"] dependencies = ["faker>=19.13.0", "pygithub>=2.1.1", "requests>=2.31.0"]
[project.urls] [project.urls]
Homepage = "https://github.com/athul/waka-readme" Homepage = "https://github.com/athul/waka-readme"
@ -36,7 +36,7 @@ extra = ["loguru>=0.7.2", "python-dotenv>=1.0.0"]
############################# #############################
[tool.pdm.dev-dependencies] [tool.pdm.dev-dependencies]
tooling = ["bandit>=1.7.5", "black>=23.10.0", "ruff>=0.1.1", "pyright>=1.1.332"] tooling = ["bandit>=1.7.5", "black>=23.11.0", "ruff>=0.1.4", "pyright>=1.1.334"]
#################### ####################
# Configurations # # Configurations #
@ -47,11 +47,11 @@ exclude_dirs = [".github", "tests", ".venv", ".vscode"]
[tool.black] [tool.black]
line-length = 100 line-length = 100
target-version = ["py311"] target-version = ["py312"]
[tool.pyright] [tool.pyright]
exclude = ["**/__pycache__", ".venv/"] exclude = ["**/__pycache__", ".venv/"]
pythonVersion = "3.11" pythonVersion = "3.12"
pythonPlatform = "All" pythonPlatform = "All"
typeCheckingMode = "strict" typeCheckingMode = "strict"
@ -72,7 +72,7 @@ select = [
"D", "D",
] ]
line-length = 100 line-length = 100
target-version = "py311" target-version = "py312"
extend-exclude = ["**/__pycache__"] extend-exclude = ["**/__pycache__"]
[tool.ruff.isort] [tool.ruff.isort]