Metadata-Version: 2.1
Name: quiltplus
Version: 0.7.3
Summary: Resource-oriented Python API/CLI for Quilt's decentralized social knowledge platform
License: MIT
Keywords: yaml,api,resource,quilt
Author: Ernest Prabhakar
Author-email: ernest@quiltdata.io
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: anyio (>=3.6.2,<4.0.0)
Requires-Dist: asyncclick (>=8.1.3.4,<9.0.0.0)
Requires-Dist: isort (>=5.12.0,<6.0.0)
Requires-Dist: pytest-cov (>=4.0.0,<5.0.0)
Requires-Dist: quilt3 (>=5.1.0,<6.0.0)
Requires-Dist: trio (>=0.22.0,<0.23.0)
Description-Content-Type: text/markdown

# quiltplus
Resource-oriented API for Quilt's decentralized social knowledge platform

## Command-Line QuickStart

```bash
pip install quiltplus
qp -U "quilt+s3://quilt-example#package=examples/echarts" pkg # get
qp list
qp --help
```

### Detailed Command-Line

```bash
export WRITE_BUCKET=writeable_s3_bucket
# create empty package and save to config
qp -U "quilt+s3://$(WRITE_BUCKET)#package=test/quiltplus" pkg -x post
time > README.md
qp stage -a README.md
qp stage # displays staged files
qp pkg -x patch # uploads staged files
```

## Developmment

Uses the [trio](https://trio.readthedocs.io/en/stable/) version of Python's `async` I/O

```bash
git clone https://github.com/quiltdata/quiltplus
cd quiltplus
poetry self update
poetry install
export WRITE_BUCKET=writeable_s3_bucket
poetry run pytest --cov-report html && open htmlcov/index.html
poetry run ptw --now .
```
## Pushing Changes
Be sure you to first set your [API token](https://pypi.org/manage/account/) using `poetry config pypi-token.pypi <pypi-api-token>`

```bash
# merge PR
poetry version patch # minor major
poetry build
poetry publish
# create new branch
poetry version prepatch # preminor premajor
```

