https://github.com/arisilon/batcave
A useful collection of tools for writing Python programs.
https://github.com/arisilon/batcave
library programming python
Last synced: about 1 month ago
JSON representation
A useful collection of tools for writing Python programs.
- Host: GitHub
- URL: https://github.com/arisilon/batcave
- Owner: Arisilon
- License: mit
- Created: 2023-11-15T22:02:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-10T03:29:12.000Z (about 1 month ago)
- Last Synced: 2026-02-10T04:16:26.094Z (about 1 month ago)
- Topics: library, programming, python
- Language: Python
- Homepage: https://pypi.org/project/batcave/
- Size: 939 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# BatCave Python Module
A useful collection of tools for writing Python programs.
## Developing
Development is best accomplished using virtualenv or virtualenv-wrapper where a virtual environment can be generated:
UNIX: util/new-env.sh
Windows: util\New-Env.ps1
To update the current development environment
UNIX: util/update-env.sh
Windows: util\Update-Env.ps1
## Testing
### Static Analysis
The static analysis test can be run with
vjer test
### Unit Tests
The unit tests can be run with
python -m unittest -v [tests.test_suite[.test_class[.test_case]]]
## Building
The build can be run with
vjer build
## Publishing a Release
This is the procedure for releasing BatCave
1. Validate that all issues are "Ready for Release".
1. Update CHANGELOG.md.
1. Run the Publish workflow against the Production environment.
1. Validate the GitHub release and tag.
1. Validate PyPi was published properly.
1. Label the issues as res::complete and mark as "Completed".
1. Close the Milestone.
1. If this was a release branch, merge to master.