2023-03-24 01:25:36 +00:00
|
|
|
# plankapy
|
|
|
|
|
A python 3 based API for controlling a self-hosted Planka instance
|
2023-05-01 18:46:26 +00:00
|
|
|
|
refactor: restructure project for pip packaging
Restructured the entire project directory, making `plankapy` pip-installable, enhancing its modularity and maintainability. This involved moving and renaming Python source files and tests into a dedicated `src/plankapy` structure, introducing a `pyproject.toml` for modern packaging standards, and removing obsolete `setup.py` and `__init__.py` files. Updated CI/CD pipelines to accommodate the new structure, ensuring continued automation efficiency. Added a `test_config.py` for centralized test configuration, improving test reliability and ease of modification.
- Migrated project documentation and workflow under new `.forgejo` directory for consistency with Forgejo platform requirements.
- Enhanced Docker containerization in CI builds by specifying a node-based container, streamlining the environment setup process.
- Expanded `.gitignore` to include `venv/`, promoting local development best practices.
- Introduced a comprehensive README update, clarifying the project's forked nature and pip-installation goal, fostering better community understanding and contribution suitability.
2024-04-25 06:48:11 +00:00
|
|
|
This is a fork of the original [plankapy](https://github.com/hwelch-fle/plankapy)
|
|
|
|
|
project by [hwelch-fle](https://github.com/hwelch-fle) that primarily focuses on
|
|
|
|
|
making the project a pip installable package.
|
|
|
|
|
|
2023-05-01 19:50:44 +00:00
|
|
|
[Docs](https://hwelch-fle.github.io/plankapy/plankapy.html)
|
2023-05-24 20:03:19 +00:00
|
|
|
|
|
|
|
|
# Rest API Source
|
2023-05-24 20:04:09 +00:00
|
|
|
|
|
|
|
|
## Routes
|
2023-05-24 20:03:19 +00:00
|
|
|
https://github.com/plankanban/planka/blob/master/server/config/routes.js
|
2023-05-24 20:04:09 +00:00
|
|
|
|
|
|
|
|
## Models
|
|
|
|
|
https://github.com/plankanban/planka/tree/master/server/api/models
|
2023-05-24 20:05:02 +00:00
|
|
|
|
|
|
|
|
## Helpers
|
|
|
|
|
https://github.com/plankanban/planka/tree/master/server/api/helpers
|
