Skip to content

Commit 22898e6

Browse files
preparing release v0.1.0
1 parent a0caca9 commit 22898e6

File tree

4 files changed

+6
-53
lines changed

4 files changed

+6
-53
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
## Unreleased
4+
5+
## 0.1.0 - 2025-10-17
6+
- Initial release: simple Calculator API (Operation, Registry, utils) with good practices for coding project such as testing, documentation, type checking, CI/CD for tests and documentation…

README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ This simple code is used to showcase some good coding practices.
1818
- [Examples & experiments](#examples--experiments)
1919
- [Documentation](#documentation)
2020
- [Running tests](#running-tests)
21-
- [Project structure](#project-structure)
2221
- [Contributing](#contributing)
2322
- [License](#license)
2423

@@ -85,8 +84,6 @@ calc.register(Operation('inc', inc, arity=1), replace=True)
8584
print(calc.apply('inc', 4)) # -> 5
8685
```
8786

88-
## Examples & experiments
89-
9087
- `experiments/` — short runnable demos.
9188
- `notebooks/` — exploratory notebooks.
9289

@@ -110,25 +107,6 @@ pytest -q --cov=python_project_template_AS --cov-report=term --cov-report=html
110107

111108
Open `htmlcov/index.html` to view the coverage report.
112109

113-
## Project structure
114-
115-
```
116-
src/python_project_template_AS/ # Core library package
117-
calculator.py # Calculator API
118-
operations.py # Built-in operations
119-
registry.py # Operation registry
120-
exceptions.py # Custom error types
121-
utils.py # Utility functions
122-
examples/ # Example usage of API
123-
tests/ # Test suite
124-
docs/ # Documentation (Sphinx source)
125-
.github/workflows/ # CI workflows (tests, docs)
126-
pyproject.toml # Project configuration and packaging
127-
README.md # This file
128-
LICENSE # License text
129-
CITATION.cff # Citation metadata
130-
```
131-
132110
## Contributing
133111

134112
Contributions are welcome. Typical workflow:

docs/appendix.rst

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ This code is used to showcase a number of good software practices. See the next
1818
docs_github
1919
structure
2020
api
21-
appendix
2221

2322

2423
Indices and tables

0 commit comments

Comments
 (0)