Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .config/dictionaries/python.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
codeowner
kayma
pytest
setuptools
14 changes: 14 additions & 0 deletions pr-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
chore: set up the Python project <!-- markdownlint-disable-line first-line-heading -->

# Description

Adds the necessary files to set up a Python project.

# TODOs

- [ ] solve all TODOs in `setup.cfg`
- [ ] remove everything from the PR body

# Remarks

- The `setup.cfg` file is a configuration file for setuptools. It contains metadata about the project and the dependencies.
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ['setuptools==75.6.0']
build-backend = 'setuptools.build_meta'
40 changes: 40 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
[metadata]
́́# TODO insert project name. Must match the name in the python-publish.yml workflow file
name = todo-my-fancy-project-name
version = 1.0.0
author = Hapag-Lloyd AG
author_email = [email protected]
description = TODO insert project description
long_description = file: README.md
long_description_content_type = text/markdown
# TODO insert project homepage
url = https://github.com/Hapag-Lloyd/todo-my-fancy-project-name
project_urls =
# TODO insert project URLs
Bug Tracker = https://github.com/Hapag-Lloyd/rds-proxy-password-rotation/issues
repository = https://github.com/Hapag-Lloyd/rds-proxy-password-rotation
classifiers =
Programming Language :: Python :: 3
# TODO insert project license
License :: OSI Approved :: Apache Software License
Operating System :: OS Independent

[options]
package_dir =
= src
packages = find:
# TODO insert python version
python_requires = >=3.10
install_requires =

[options.extras_require]
test =
pytest==8.3.4
pytest-cov==6.0.0

# TODO try running the tests without the following nose dependency first
# updates an outdated dependency of local setup
nose==1.3.7

[options.packages.find]
where = src