Skip to content

Package / pyproject.toml#22

Open
dweindl wants to merge 6 commits into
hnolCol:masterfrom
dweindl:pyproject
Open

Package / pyproject.toml#22
dweindl wants to merge 6 commits into
hnolCol:masterfrom
dweindl:pyproject

Conversation

@dweindl

@dweindl dweindl commented May 4, 2026

Copy link
Copy Markdown
Contributor

Create a proper Python package. Simplifies installation (e.g., currently via pip install git+https://github.com/dweindl/ComplexFinder.git@pyproject) and will allow deploying the package to PyPI.

  • Add pyproject.toml
  • Move some Python modules for proper project layout
  • Move reference-data/ to include it in the package.
    Not sure it belongs into the package or if users should just download their own reference files. For now, I included it. Minor issue: The database file is written to that directory after filtering. Ideally, Python packages shouldn't modify their installation directory after installation (and it may not always be writable). For that I added an additional databaseDir option to allow users choose a custom directory for looking up and caching those files.
  • Updated installation instructions

Python package names are usually all lower case, so I went for complexfinder. Feel free to choose any other name.

Also feel free update any other package metadata.

@dweindl dweindl force-pushed the pyproject branch 2 times, most recently from 19daa3b to 102d071 Compare May 6, 2026 06:25
@dweindl dweindl marked this pull request as ready for review May 6, 2026 07:06
The default reference database directory is currently inside the installation
directory. This may not always be writable. Thus, allow specifying a custom directory.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant