ritebook 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
ritebook/__init__.py
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ritebook
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A minimal placeholder package for the future Ritebook project.
|
|
5
|
+
Project-URL: Homepage, https://github.com/ondrej-winter/ritebook
|
|
6
|
+
Project-URL: Repository, https://github.com/ondrej-winter/ritebook
|
|
7
|
+
Project-URL: Issues, https://github.com/ondrej-winter/ritebook/issues
|
|
8
|
+
Author: Ondřej Winter
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: ritebook
|
|
12
|
+
Classifier: Development Status :: 1 - Planning
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Typing :: Typed
|
|
18
|
+
Requires-Python: >=3.13
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
|
|
21
|
+
# ritebook
|
|
22
|
+
|
|
23
|
+
Ritebook is currently a minimal Python package placeholder intended to reserve
|
|
24
|
+
the package name on PyPI while the project is being designed.
|
|
25
|
+
|
|
26
|
+
## Requirements
|
|
27
|
+
|
|
28
|
+
- Python 3.13 or newer
|
|
29
|
+
- [uv](https://docs.astral.sh/uv/) for dependency management and command
|
|
30
|
+
execution
|
|
31
|
+
|
|
32
|
+
## Development setup
|
|
33
|
+
|
|
34
|
+
Install development dependencies:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
uv sync --group dev
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Run local quality checks:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
uv run ruff format .
|
|
44
|
+
uv run ruff check .
|
|
45
|
+
uv run mypy .
|
|
46
|
+
uv run pytest
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Build the package distributions:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
uv build
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Publishing
|
|
56
|
+
|
|
57
|
+
The GitHub Actions workflow in `.github/workflows/ci-cd.yaml` runs formatting,
|
|
58
|
+
linting, type checking, tests, and package builds. It publishes to PyPI when a
|
|
59
|
+
GitHub release is published.
|
|
60
|
+
|
|
61
|
+
Publishing uses PyPI Trusted Publishing through GitHub Actions OIDC. Before the
|
|
62
|
+
first release, configure a trusted publisher for this repository in the PyPI
|
|
63
|
+
project settings:
|
|
64
|
+
|
|
65
|
+
- Repository owner: `ondrej-winter`
|
|
66
|
+
- Repository name: `ritebook`
|
|
67
|
+
- Workflow filename: `ci-cd.yaml`
|
|
68
|
+
- Environment name: `pypi`
|
|
69
|
+
|
|
70
|
+
## Architecture direction
|
|
71
|
+
|
|
72
|
+
Future business capabilities should be implemented as vertical feature slices
|
|
73
|
+
under `src/ritebook/features/`, keeping domain, application ports/use cases, and
|
|
74
|
+
adapters separated according to hexagonal architecture principles.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
ritebook/__init__.py,sha256=tUUaW0iF1t4hcifmuD2WOtujs7mFq4ZeD6fY_aQWm9g,86
|
|
2
|
+
ritebook-0.1.0.dist-info/METADATA,sha256=D3ESRcECx-tpTnuRNY2PV1mDXGNsv8NogvWpgHqrB3E,2042
|
|
3
|
+
ritebook-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
|
|
4
|
+
ritebook-0.1.0.dist-info/licenses/LICENSE,sha256=6WM3cV_Llm1Ux_YHQiUq0VQgPri6xqP59HepFfkBylE,1071
|
|
5
|
+
ritebook-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Ondřej Winter
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|