https://github.com/release-engineering/pushcollector
A Python library to collect information from push tasks
https://github.com/release-engineering/pushcollector
Last synced: about 1 year ago
JSON representation
A Python library to collect information from push tasks
- Host: GitHub
- URL: https://github.com/release-engineering/pushcollector
- Owner: release-engineering
- License: gpl-3.0
- Created: 2019-07-10T22:59:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-22T21:39:51.000Z (over 1 year ago)
- Last Synced: 2025-03-25T13:11:28.509Z (about 1 year ago)
- Language: Python
- Size: 542 KB
- Stars: 1
- Watchers: 9
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
pushcollector
=============
A Python library for collecting information from push tasks, used by
[release-engineering](https://github.com/release-engineering) publishing tools.
[](https://travis-ci.org/release-engineering/pushcollector)
[](https://coveralls.io/github/release-engineering/pushcollector?branch=master)
- [Source](https://github.com/release-engineering/pushcollector)
- [Documentation](https://release-engineering.github.io/pushcollector/)
- [PyPI](https://pypi.org/project/pushcollector)
Installation
------------
Install the `pushcollector` package from PyPI.
```
pip install pushcollector
```
Usage Example
-------------
```python
from pushcollector import Collector
# Get an instance of a collector; the concrete backend returned
# may differ per execution environment
collector = Collector.get()
# Save a log file
collector.attach_file('pushlog.json', json.dumps(somedata)).result()
# Append to a log file
collector.append_file('pushlog.txt', sometext).result()
# Save some push item(s)
collector.update_push_items(items).result()
```
Development
-----------
Patches may be contributed via pull requests to
https://github.com/release-engineering/pushcollector.
All changes must pass the automated test suite, along with various static
checks.
The [Black](https://black.readthedocs.io/) code style is enforced.
Enabling autoformatting via a pre-commit hook is recommended:
```
pip install -r requirements-dev.txt
pre-commit install
```
License
-------
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.