{"id":26440309,"url":"https://github.com/preocts/picartoapi","last_synced_at":"2025-10-08T00:23:29.650Z","repository":{"id":37938011,"uuid":"483483473","full_name":"Preocts/picartoapi","owner":"Preocts","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-11T22:03:08.000Z","size":107,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-16T23:46:14.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Preocts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-20T02:45:18.000Z","updated_at":"2022-10-02T21:25:23.000Z","dependencies_parsed_at":"2023-01-28T16:46:03.453Z","dependency_job_id":null,"html_url":"https://github.com/Preocts/picartoapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Preocts%2Fpicartoapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Preocts%2Fpicartoapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Preocts%2Fpicartoapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Preocts%2Fpicartoapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Preocts","download_url":"https://codeload.github.com/Preocts/picartoapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244191620,"owners_count":20413333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-18T09:27:38.803Z","updated_at":"2025-10-08T00:23:24.634Z","avatar_url":"https://github.com/Preocts.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Code style:\nblack](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![pre-commit.ci\nstatus](https://results.pre-commit.ci/badge/github/Preocts/picartoapi/main.svg)](https://results.pre-commit.ci/latest/github/Preocts/picartoapi/main)\n[![Python\npackage](https://github.com/Preocts/picartoapi/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/Preocts/picartoapi/actions/workflows/python-tests.yml)\n\n# picartoapi\n\nAPI client for the Public endpoints of Picarto API v1\n\n### Requirements\n\n- [Python](https://python.org) \u003e= 3.8\n- [httpx](https://pypi.org/project/httpx/) == 0.23.0\n\n---\n\n# Local developer installation\n\nIt is **strongly** recommended to use a virtual environment\n([`venv`](https://docs.python.org/3/library/venv.html)) when working with python\nprojects. Leveraging a `venv` will ensure the installed dependency files will\nnot impact other python projects or any system dependencies.\n\nThe following steps outline how to install this repo for local development. See\nthe [CONTRIBUTING.md](CONTRIBUTING.md) file in the repo root for information\non contributing to the repo.\n\n**Windows users**: Depending on your python install you will use `py` in place\nof `python` to create the `venv`.\n\n**Linux/Mac users**: Replace `python`, if needed, with the appropriate call to\nthe desired version while creating the `venv`. (e.g. `python3` or `python3.8`)\n\n**All users**: Once inside an active `venv` all systems should allow the use of\n`python` for command line instructions. This will ensure you are using the\n`venv`'s python and not the system level python.\n\n---\n\n## Installation steps\n\nClone this repo and enter root directory of repo:\n\n```bash\ngit clone https://github.com/Preocts/picartoapi\ncd picartoapi\n```\n\nCreate the `venv`:\n\n```bash\npython -m venv venv\n```\n\nActivate the `venv`:\n\n```bash\n# Linux/Mac\n. venv/bin/activate\n\n# Windows\nvenv\\Scripts\\activate\n```\n\nThe command prompt should now have a `(venv)` prefix on it. `python` will now\ncall the version of the interpreter used to create the `venv`\n\nInstall editable library and development requirements:\n\n```bash\n# Update pip and tools\npython -m pip install --upgrade pip wheel setuptools\n\n# Install development requirements\npython -m pip install -r requirements-dev.txt\n\n# Install editable version of library\npython -m pip install --editable .\n```\n\nInstall pre-commit [(see below for details)](#pre-commit):\n\n```bash\npre-commit install\n```\n\n---\n\n## Misc Steps\n\nRun pre-commit on all files:\n\n```bash\npre-commit run --all-files\n```\n\nRun tests:\n\n```bash\ntox\n```\n\nTo deactivate (exit) the `venv`:\n\n```bash\ndeactivate\n```\n\n---\n\n## [pre-commit](https://pre-commit.com)\n\n\u003e A framework for managing and maintaining multi-language pre-commit hooks.\n\nThis repo is setup with a `.pre-commit-config.yaml` with the expectation that\nany code submitted for review already passes all selected pre-commit checks.\n`pre-commit` is installed with the development requirements and runs seemlessly\nwith `git` hooks.\n\n---\n\n## Makefile\n\nThis repo has a Makefile with some quality of life scripts if the system\nsupports `make`.  Please note there are no checks for an active `venv` in the\nMakefile.\n\n| PHONY             | Description                                                        |\n| ----------------- | ------------------------------------------------------------------ |\n| `init`            | Update pip, setuptools, and wheel to newest version                |\n| `install`         | install project                                                    |\n| `install-dev`     | install development requirements and project                       |\n| `build-dist`      | Build source distribution and wheel distribution                   |\n| `clean-artifacts` | Deletes python/mypy artifacts including eggs, cache, and pyc files |\n| `clean-tests`     | Deletes tox, coverage, and pytest artifacts                        |\n| `clean-build`     | Deletes build artifacts                                            |\n| `clean-all`       | Runs all clean scripts                                             |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreocts%2Fpicartoapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpreocts%2Fpicartoapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreocts%2Fpicartoapi/lists"}