Releases: munterfi/bgpy
Releases · munterfi/bgpy
bgpy 0.3.1-1
- Bugfixes:
- Adjust URLs to GitHub account due to renaming @munterfinger to @munterfi.
- Increase version.
bgpy 0.3.1
- Bugfixes:
- Adjust URLs to GitHub account due to renaming @munterfinger to @munterfi.
bgpy 0.3.0
bgpy 0.2.0
- Features:
- CLI command
bgpy version
to check for the version of the package. - Restructure environment variables, remove
HOST
andPORT
from core socket classes. - Move log file handling to the interface, create seperate log file for each test and upload as artifacts in github action package check.
- Split
interface.py
into aServer
context class and aClient
context class. - Added
__repr__
methods toClient
,Server
andMessage
classes. - Define
__slots__
for all classes. - Use
logging
package from the standard library to perform logging tasks. Split logs at level INFO into STDOUT and STDERR on the stream handler for the console. - Documented CLI help pages.
- Detailed usage section in README.
- CLI command
- Bugfixes:
- Updated docstrings.
- Cleaned environment and removed the need for a directory in the users home (
~/.bgpy
). - Render module index and docstrings on readthedocs.
- Pass mypy type checks.
- Run sphinx-apidoc in
check.sh
script to avoid errors in documentation build when changing submodule structure.
bgpy 0.1.0
- Initial release of the bgpy package on pypi.org; Running local or remote python servers in the background and establish stream socket-based communication with clients.
- Development setup:
poetry
: Managing dependencies and package build env.pytest
: Framework for testing.mypy
: Static type checking.flake8
: Code linting.sphinx
: Documentation of the package using numpydoc docstring style.
- Submodules:
- example: Example
init_task
,exec_task
andexit_task
for testing. - cli:
bgpy server <host> <port>
to run a server andbgpy terminate <host> <port>
to send exit message to a server.
- example: Example
- Scripts:
install.sh
: Builds the package and installs it to the global python version.check.sh
: Automates checks and documentation build.