Skip to content

Commit 34a26f7

Browse files
committed
Initial commit
Signed-off-by: Leandro Lucarella <[email protected]>
0 parents  commit 34a26f7

File tree

10 files changed

+790
-0
lines changed

10 files changed

+790
-0
lines changed

.gitignore

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
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
28+
.vscode
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.htmlcov*/
43+
.tox/
44+
.nox/
45+
.coverage
46+
.coverage.*
47+
.cache
48+
nosetests.xml
49+
coverage.xml
50+
*.cover
51+
*.py,cover
52+
.hypothesis/
53+
.pytest_cache/
54+
cover/
55+
56+
# Translations
57+
*.mo
58+
*.pot
59+
60+
# Django stuff:
61+
*.log
62+
local_settings.py
63+
db.sqlite3
64+
db.sqlite3-journal
65+
66+
# Flask stuff:
67+
instance/
68+
.webassets-cache
69+
70+
# Scrapy stuff:
71+
.scrapy
72+
73+
# Sphinx documentation
74+
docs/_build/
75+
76+
# PyBuilder
77+
.pybuilder/
78+
target/
79+
80+
# Jupyter Notebook
81+
.ipynb_checkpoints
82+
83+
# IPython
84+
profile_default/
85+
ipython_config.py
86+
87+
# pyenv
88+
# For a library or package, you might want to ignore these files since the code is
89+
# intended to run in multiple environments; otherwise, check them in:
90+
# .python-version
91+
92+
# pipenv
93+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
94+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
95+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
96+
# install all needed dependencies.
97+
#Pipfile.lock
98+
99+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
100+
__pypackages__/
101+
102+
# Celery stuff
103+
celerybeat-schedule
104+
celerybeat.pid
105+
106+
# SageMath parsed files
107+
*.sage.py
108+
109+
# Environments
110+
.env
111+
.venv
112+
env/
113+
venv/
114+
ENV/
115+
env.bak/
116+
venv.bak/
117+
118+
# Spyder project settings
119+
.spyderproject
120+
.spyproject
121+
122+
# Rope project settings
123+
.ropeproject
124+
125+
# mkdocs documentation
126+
/site
127+
128+
# mypy
129+
.mypy_cache/
130+
.dmypy.json
131+
dmypy.json
132+
133+
# Pyre type checker
134+
.pyre/
135+
136+
# pytype static type analyzer
137+
.pytype/
138+
139+
# Cython debug symbols
140+
cython_debug/
141+
142+
# PyCharm
143+
.idea
144+
145+
# Automatically generated documentation
146+
docs/reference/
147+
site/

noxfile.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# License: MIT
2+
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
3+
4+
"""Configuration file for nox."""
5+
6+
from frequenz.repo import config
7+
8+
# Remove the pytest sessions because we don't have tests yet
9+
conf = config.nox.default.lib_config.copy()
10+
conf.sessions = [s for s in conf.sessions if not s.startswith("pytest")]
11+
12+
config.nox.configure(conf)

pyproject.toml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
[build-system]
2+
requires = ["setuptools == 67.6.0", "setuptools_scm[toml] == 7.1.0"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "frequenz-repo-config"
7+
description = "Frequenz project setup tools and common configuration"
8+
readme = "README.md"
9+
license = { text = "MIT" }
10+
keywords = ["frequenz", "package", "project", "config", "tool"]
11+
classifiers = [
12+
"Development Status :: 3 - Alpha",
13+
"Intended Audience :: Developers",
14+
"License :: OSI Approved :: MIT License",
15+
"Programming Language :: Python :: 3",
16+
"Programming Language :: Python :: 3 :: Only",
17+
"Programming Language :: Python :: 3.11",
18+
"Topic :: Software Development :: Libraries",
19+
]
20+
requires-python = ">= 3.11, < 4"
21+
dependencies = ["nox >= 2022.11.21"]
22+
dynamic = ["version"]
23+
24+
[[project.authors]]
25+
name = "Frequenz Energy-as-a-Service GmbH"
26+
27+
28+
[project.optional-dependencies]
29+
docs-gen = [
30+
"mike == 1.1.2",
31+
"mkdocs-gen-files == 0.4.0",
32+
"mkdocs-literate-nav == 0.4.0",
33+
"mkdocs-material == 9.1.4",
34+
"mkdocs-section-index == 0.3.5",
35+
"mkdocstrings[python] == 0.20.0",
36+
]
37+
docs-lint = ["pydocstyle == 6.3.0", "darglint == 1.8.1"]
38+
format = ["black == 23.3.0", "isort == 5.12.0"]
39+
mypy = [
40+
"mypy == 1.1.1",
41+
# For checking the docs/ script, and tests
42+
"frequenz-repo-config[docs-gen,pytest]",
43+
]
44+
pylint = [
45+
"pylint == 2.17.1",
46+
"pylint-google-style-guide-imports-enforcing == 1.3.0",
47+
# For checking the docs/ script, and tests
48+
"frequenz-repo-config[docs-gen,pytest]",
49+
]
50+
pytest = ["pytest == 7.2.2"]
51+
dev = ["frequenz-repo-config[docs-gen,docs-lint,format,pytest,mypy,pylint]"]
52+
53+
[project.urls]
54+
Changelog = "https://github.com/frequenz-floss/frequenz-repo-config-python/releases"
55+
Repository = "https://github.com/frequenz-floss/frequenz-repo-config-python"
56+
Issues = "https://github.com/frequenz-floss/frequenz-repo-config-python/issues"
57+
Support = "https://github.com/frequenz-floss/frequenz-repo-config-python/discussions/categories/support"
58+
59+
[tool.setuptools]
60+
include-package-data = true
61+
62+
[tool.setuptools_scm]
63+
version_scheme = "post-release"
64+
65+
[tool.black]
66+
line-length = 88
67+
target-version = ['py311']
68+
include = '\.pyi?$'
69+
70+
[tool.pylint.messages_control]
71+
disable = [
72+
"too-few-public-methods",
73+
# disabled because it conflicts with isort
74+
"wrong-import-order",
75+
"ungrouped-imports",
76+
]
77+
78+
[tool.isort]
79+
profile = "black"
80+
line_length = 88
81+
src_paths = ["src"]

src/frequenz/py.typed

Whitespace-only changes.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# License: MIT
2+
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
3+
4+
"""Frequenz project setup tools and common configuration."""
5+
6+
from . import nox
7+
8+
__all__ = [
9+
"nox",
10+
]
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""TODO."""
2+
3+
from __future__ import annotations
4+
5+
from . import config, default, session, util
6+
from .config import configure
7+
8+
__all__ = [
9+
"config",
10+
"configure",
11+
"default",
12+
"session",
13+
"util",
14+
]

0 commit comments

Comments
 (0)