Save data from CircleCI to a SQLite database
Project description
circleci-to-sqlite
Save data from CircleCI to a SQLite database.
How to install
$ pip install circleci-to-sqlite
Authentication
Create a CircleCI personal access token: https://app.circleci.com/settings/user/tokens
Run this command and paste in your new token:
$ circleci-to-sqlite auth
This will create a file called auth.json
in your current directory containing the required value. To save the file at a different path or filename, use the --auth=myauth.json
option.
As an alternative to using an auth.json
file you can add your access token to an environment variable called CIRCLECI_TOKEN
.
Fetching all data for the current user
The circleci_to_sqlite.sh
example script shows how to download all data for the current user's followed projects, skipping jobs that already have steps.
$ ./circleci_to_sqlite.sh
Fetching followed projects for the current user
The projects
command retrieves all of the projects for the current user.
$ circleci-to-sqlite projects circleci.db
Fetching jobs for a project
The jobs
command retrieves all of the jobs belonging to a project. A project is specified by its slug, which has the form {vcs_type}/{username}/{reponame}
.
$ circleci-to-sqlite jobs circleci.db github/seem/circleci-to-sqlite
Fetching steps for a job
The steps
command retrieves all of the steps and their actions belonging to a job.
$ circleci-to-sqlite steps circleci.db github/seem/circleci-to-sqlite 8
Development
To contribute to this tool, first checkout the code. Then create a new virtual environment:
cd circleci-to-sqlite
python -mvenv venv
source venv/bin/activate
Or if you are using pipenv
:
pipenv shell
Now install the dependencies and tests:
pip install -e '.[test]'
To run the tests:
pytest
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for circleci_to_sqlite-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d2f375b19f272e738a4b240314f98e5133828f3fae96ffe7e2d164e828ab58a |
|
MD5 | 143ebba05eb1e56965904ca01c1c2825 |
|
BLAKE2b-256 | c184af2787eaee5a604432d6289c41378ed6e7c9be247bcc4974fb1af3e37421 |