Skip to content

Commit 5cb0fd6

Browse files
author
Konstantin Fadeev
committed
Init public release.
1 parent 8957e9c commit 5cb0fd6

25 files changed

+1592
-154
lines changed

‎.editorconfig‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# RTFM: https://EditorConfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
end_of_line = lf
7+
indent_style = space
8+
indent_size = 4
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
max_line_length = 100
12+
13+
[Makefile]
14+
indent_style = tab
15+
16+
[{*.yaml,*.yml,*.toml}]
17+
indent_size = 2
18+
insert_final_newline = false

‎.github/workflows/testing.yaml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: DB-First testing
2+
run-name: ${{ github.actor }} is testing DB-First
3+
on: [push]
4+
jobs:
5+
linters:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v4
9+
- uses: actions/setup-python@v5
10+
with:
11+
python-version: |
12+
3.9
13+
3.10
14+
3.11
15+
3.12
16+
- run: make format
17+
test:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: |
24+
3.9
25+
3.10
26+
3.11
27+
3.12
28+
- run: make test
29+
tox:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- uses: actions/setup-python@v5
34+
with:
35+
python-version: |
36+
3.9
37+
3.10
38+
3.11
39+
3.12
40+
- run: make tox
41+
build:
42+
runs-on: ubuntu-latest
43+
steps:
44+
- uses: actions/checkout@v4
45+
- uses: actions/setup-python@v5
46+
with:
47+
python-version: '3.12'
48+
- run: make build

‎.gitignore‎

Lines changed: 13 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -1,162 +1,23 @@
1-
# Byte-compiled / optimized / DLL files
2-
__pycache__/
3-
*.py[cod]
4-
*$py.class
5-
6-
# C extensions
7-
*.so
1+
# Virtual environment.
2+
venv/
83

9-
# Distribution / packaging
10-
.Python
11-
build/
12-
develop-eggs/
4+
# Package
135
dist/
14-
downloads/
15-
eggs/
16-
.eggs/
17-
lib/
18-
lib64/
19-
parts/
20-
sdist/
21-
var/
22-
wheels/
23-
share/python-wheels/
24-
*.egg-info/
25-
.installed.cfg
26-
*.egg
27-
MANIFEST
6+
src/DB_First.egg-info
287

29-
# PyInstaller
30-
# Usually these files are written by a python script from a template
31-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32-
*.manifest
33-
*.spec
34-
35-
# Installer logs
36-
pip-log.txt
37-
pip-delete-this-directory.txt
8+
# Python.
9+
__pycache__/
10+
*.py[cod]
11+
*$py.class
3812

39-
# Unit test / coverage reports
40-
htmlcov/
41-
.tox/
42-
.nox/
13+
# Testing.
4314
.coverage
4415
.coverage.*
45-
.cache
46-
nosetests.xml
47-
coverage.xml
4816
*.cover
49-
*.py,cover
50-
.hypothesis/
5117
.pytest_cache/
52-
cover/
53-
54-
# Translations
55-
*.mo
56-
*.pot
57-
58-
# Django stuff:
59-
*.log
60-
local_settings.py
61-
db.sqlite3
62-
db.sqlite3-journal
63-
64-
# Flask stuff:
65-
instance/
66-
.webassets-cache
67-
68-
# Scrapy stuff:
69-
.scrapy
70-
71-
# Sphinx documentation
72-
docs/_build/
73-
74-
# PyBuilder
75-
.pybuilder/
76-
target/
77-
78-
# Jupyter Notebook
79-
.ipynb_checkpoints
18+
.mypy_cache
8019

81-
# IPython
82-
profile_default/
83-
ipython_config.py
20+
# IDE and editors.
21+
.idea/
8422

85-
# pyenv
86-
# For a library or package, you might want to ignore these files since the code is
87-
# intended to run in multiple environments; otherwise, check them in:
88-
# .python-version
89-
90-
# pipenv
91-
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92-
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93-
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94-
# install all needed dependencies.
95-
#Pipfile.lock
96-
97-
# poetry
98-
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99-
# This is especially recommended for binary packages to ensure reproducibility, and is more
100-
# commonly ignored for libraries.
101-
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102-
#poetry.lock
103-
104-
# pdm
105-
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106-
#pdm.lock
107-
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108-
# in version control.
109-
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110-
.pdm.toml
111-
.pdm-python
112-
.pdm-build/
113-
114-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115-
__pypackages__/
116-
117-
# Celery stuff
118-
celerybeat-schedule
119-
celerybeat.pid
120-
121-
# SageMath parsed files
122-
*.sage.py
123-
124-
# Environments
125-
.env
126-
.venv
127-
env/
128-
venv/
129-
ENV/
130-
env.bak/
131-
venv.bak/
132-
133-
# Spyder project settings
134-
.spyderproject
135-
.spyproject
136-
137-
# Rope project settings
138-
.ropeproject
139-
140-
# mkdocs documentation
141-
/site
142-
143-
# mypy
144-
.mypy_cache/
145-
.dmypy.json
146-
dmypy.json
147-
148-
# Pyre type checker
149-
.pyre/
150-
151-
# pytype static type analyzer
152-
.pytype/
153-
154-
# Cython debug symbols
155-
cython_debug/
156-
157-
# PyCharm
158-
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159-
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160-
# and can be added to the global gitignore or merged into this file. For a more nuclear
161-
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162-
#.idea/
23+
.tox/

‎.pre-commit-config.yaml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
repos:
2+
- repo: https://github.com/asottile/pyupgrade
3+
rev: v3.17.0
4+
hooks:
5+
- id: pyupgrade
6+
args: [--py39]
7+
- repo: https://github.com/dannysepler/rm_unneeded_f_str
8+
rev: v0.2.0
9+
hooks:
10+
- id: rm-unneeded-f-str
11+
- repo: https://github.com/mxr/unkey
12+
rev: v0.0.1
13+
hooks:
14+
- id: unkey
15+
- repo: https://github.com/pre-commit/pre-commit-hooks
16+
rev: v4.6.0
17+
hooks:
18+
- id: check-ast
19+
- id: fix-byte-order-marker
20+
- id: end-of-file-fixer
21+
- id: trailing-whitespace
22+
- id: check-yaml
23+
- id: check-builtin-literals
24+
- id: check-toml
25+
- id: check-builtin-literals
26+
- id: check-yaml
27+
- id: double-quote-string-fixer
28+
- id: check-merge-conflict
29+
- repo: https://github.com/PyCQA/docformatter
30+
rev: v1.7.5
31+
hooks:
32+
- id: docformatter
33+
additional_dependencies: [tomli]
34+
args: [--in-place, --config, ./pyproject.toml]
35+
- repo: https://github.com/jshwi/docsig
36+
rev: v0.63.0
37+
hooks:
38+
- id: docsig
39+
args:
40+
- --check-class
41+
- --check-dunders
42+
- --check-overridden
43+
- --check-protected
44+
- --ignore-no-params
45+
- repo: https://github.com/psf/black
46+
rev: 24.8.0
47+
hooks:
48+
- id: black
49+
- repo: https://github.com/asottile/reorder_python_imports
50+
rev: v3.13.0
51+
hooks:
52+
- id: reorder-python-imports
53+
- repo: https://github.com/pre-commit/pygrep-hooks
54+
rev: v1.10.0
55+
hooks:
56+
- id: python-use-type-annotations
57+
- id: python-no-eval
58+
- id: text-unicode-replacement-char
59+
- repo: https://github.com/pycqa/flake8
60+
rev: 7.1.1
61+
hooks:
62+
- id: flake8
63+
additional_dependencies:
64+
- flake8-bugbear
65+
- flake8-implicit-str-concat
66+
args: [--max-line-length=100]
67+
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
68+
rev: v2.14.0
69+
hooks:
70+
- id: pretty-format-yaml
71+
args: [--autofix, --indent, '2']
72+
- id: pretty-format-toml
73+
args: [--autofix, --indent, '2']
74+
- repo: https://codeberg.org/frnmst/md-toc
75+
rev: 8.2.3
76+
hooks:
77+
- id: md-toc
78+
args: [-p, github]
79+
- repo: https://github.com/mrtazz/checkmake.git
80+
rev: 0.2.2
81+
hooks:
82+
- id: checkmake
83+
- repo: https://github.com/PyCQA/bandit
84+
rev: 1.7.10
85+
hooks:
86+
- id: bandit
87+
args: [-c, pyproject.toml]
88+
additional_dependencies: ['bandit[toml]']
89+
default_language_version:
90+
python: python3.9

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.12

‎CHANGES.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Version 1.0.0
2+
3+
* Initial public release.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 flask-pro
3+
Copyright (c) 2024 Konstantin Fadeev
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎MANIFEST.in‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
recursive-include src/db_first *
2+
graft examples
3+
graft tests
4+
global-exclude *.pyc

0 commit comments

Comments
 (0)