Kumi
4a6c825394
All checks were successful
Python Package CI/CD / Publish to PyPI (push) Successful in 40s
Introduced a `Calendar` class to encapsulate calendar-related functionalities, removing redundant code and improving module organization. This refactor simplifies `__main__.py` by delegating calendar operations to the `Calendar` class, enhancing readability and maintainability. Adjusted import statements in `__init__.py` to reflect these changes, ensuring the module's public API remains clear and intuitive. The refactor also includes minor optimizations, such as consolidating validation logic and updating default image data, contributing to a leaner codebase. This change aims to make future extensions and maintenance of the `kalente` module more manageable, paving the way for further enhancements and features. |
||
|---|---|---|
| .forgejo/workflows | ||
| src/kalente | ||
| .gitignore | ||
| LICENSE | ||
| pyproject.toml | ||
| README.md | ||
| requirements-dev.txt | ||
Kalente
Kalente is a simple Python script for generating PDF calendars.
It can be used to generate weekly and monthly calendars at the moment, and it will be extended to support yearly calendars as well.
Currently, Kalente can only generate calendars in English, but support for other languages will be added in the future. Also, calendars are currently generated in A4 landscape format, but support for other formats will be added in the future. If you can help with any of these, please feel free to open a pull request.
Requirements
Kalente should work with any Python version from 3.8 onwards.
It also requires wkhtmltopdf to be installed on your system. You can find instructions on how to install it on your system on the project's website.
Installation
First, set up a virtual environment for Kalente:
python -m venv venv
Then, activate the virtual environment:
source venv/bin/activate
You can install Kalente using pip:
pip install kalente
Usage
Kalente can be used as a command line tool to generate calendars. You can generate weekly calendars using the following command:
kalente --type weekly --date 2021-01-01 --output weekly.pdf
This will generate a weekly calendar for the week of January 1st, 2021. The
calendar will be saved to the file weekly.pdf.
You can also generate monthly calendars using the following command:
kalente --type monthly --date 2021-08-01 --output monthly.pdf
This will generate a monthly calendar for August 2021 and save it to the file
monthly.pdf.
You can also use the --help option to get more information about the
available options:
kalente --help
For example, you may want to look into the --end-date and --count options
to generate calendars for multiple weeks or months.
License
Kalente is licensed under the MIT license. See the LICENSE file for more information.