https://github.com/beaverhouse/python-script-hub
Effort to increase productivity by using Python
https://github.com/beaverhouse/python-script-hub
python readme-generation testing
Last synced: 2 months ago
JSON representation
Effort to increase productivity by using Python
- Host: GitHub
- URL: https://github.com/beaverhouse/python-script-hub
- Owner: BeaverHouse
- License: mit
- Created: 2024-02-04T07:18:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-17T14:39:47.000Z (about 1 year ago)
- Last Synced: 2025-01-30T01:43:07.228Z (4 months ago)
- Topics: python, readme-generation, testing
- Language: Python
- Homepage:
- Size: 171 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Effort to increase productivity by using Python
Bug Report
|
Request to HU-Lee
## Description
Effort to increase productivity by using [Python][py].
**Current features**
| **Feature** | **Location** |
| :------------------------- | :---------------------------------------- |
| Test repository README | `test/test_content.py::test_repo_readme` |
| Test README template | `test/test_repo.py::test_readme_template` |
| Test repository settings\* | `test/test_repo.py::test_repo_settings` |
| README generation | `hub.making.readme` |
\*: GitHub API does not support entire access to its features.
[py]: https://www.python.org/
[blog]: https://github.com/BeaverHouse/blog
[wiki]: https://wiki.haulrest.me/
## Requirements
1. You need to install [Python 3.12][py312] and [Poetry][poetry] to manage the packages.
To install Poetry:
```
curl -sSL https://install.python-poetry.org | python3 -
```
2. You need to set environment variables.
If you want to fork the repository and run GitHub Actions, set them as a repository secret too.
- `GH_PAT_ORGANIZATION` : Fine-grained access token for organization repositories
- `GH_PAT_PERSONAL` : Fine-grained access token for personal repositories
3. Configure [Codecov][codecov] to make code coverage analysis.
Delete the related code if unnecessary.
**Install packages**
```
poetry install
```
[poetry]: https://python-poetry.org/
[py312]: https://www.python.org/downloads/release/python-3120/
[codecov]: https://about.codecov.io/
## Getting started
**Make README**
```
python -m hub.making.readme
```
**Test**
```
python -m pytest --cov test
```
## OSS Notice
See the [OSS Notice | python-script-hub][oss-notice].
[oss-notice]: ./OSS.md
## Contributing
See the [CONTRIBUTING.md][contributing].
[contributing]: ./CONTRIBUTING.md