Access file paths from pyproject.toml
Project description
project-paths
Access file paths from pyproject.toml
Thanks to @Madoshakalaka for the idea!
# pyproject.toml
[tool.project-paths]
readme = "README.md"
# app.py
from project_paths import paths
# paths.readme is a pathlib.Path object:
print(paths.readme.read_text())
Install
pip install project-paths
Usage
Does your application have a bunch of configurable file paths? Do you wish you just had one place to configure list them all?
Add paths to [tool.project-paths]
With this module, define your paths in your pyproject.toml
file under
the [tool.project-paths]
table:
[tool.project-paths]
docs = "path/to/my/docs"
settings = "path/to/my/settings.py"
config = "/opt/path/to/my/config
# Add as many paths as you want!
Anything string defined with [tool.project-paths]
will be made
available. Relative paths are relative to pyproject.toml
.
Access paths using project_paths.paths.<path name>
Now you can access all the paths listed in pyproject.toml
with
project_paths.paths
. Every path is returned as
a pathlib.Path
object:
from project_paths import paths
print(paths.docs.glob("*.md"))
assert paths.config.exists()
exec(paths.settings.read_text())
# Or anything you want!
Caveats
Names in [tool.project-paths]
should be a valid Python identifier
and the names cannot have a leading underscore. If a name has
a leading underscore, a warning is issued and the name is inaccessible:
[tool.project-paths]
# BAD: paths that start with a '_' cannot be used
_my_path = "path/to/wherever"
# GOOD: path is a valid Python identifier!
my_path = "path/to/wherever"
Errors
All intentional errors inherit from project_paths.ProjectPathError
.
PyProjectNotFoundError
Raised when project_paths
cannot find an appropriate pyproject.toml
for the caller. This can happen if the caller simply does not have
a pyproject.toml
file, or when it's not possible to determine the
caller's filename.
NOTE: if accessing paths from the interactive console,
project_paths
will find the appropriatepyproject.toml
relative to the current working directory!
ConfigurationNotFoundError
Raised when project_paths
cannot find the [tool.project-paths]
table
within the pyproject.toml
file. Perhaps there is a typo or perhaps the
project_paths
inferred the incorrect module path.
License
2021 © Eddie Antonio Santos. MIT Licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for project_paths-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 671e211c3b8d90e87cb5793e9894f0469efe59b21b679b6cdb226ebf9cd5ac11 |
|
MD5 | 3a547f4ff2595e71c7fa4aeb0ca881b8 |
|
BLAKE2b-256 | b7e6fa589b1f07759f286f4232bbdf329fa16e212467c13780b66558fcbf1ebf |