Skip to main content

Furrycorn: JSONAPI v1.0 Parser

Furrycorn is intended to make interacting with jsonapi-outputting APIs easier to consume. It is opinionated but lienient when possible, failing fast when things go awry.

To understand how to use this library, you will need some knowledge of the jsonapi v1.0 specification.

Furrycorn provides:

  1. a URL abstraction for interacting with services hosting jsonapi APIs.

  2. a DOM-like object model of entities in jsonapi response bodies.

  3. a toolkit for relationship traversal and entity iteration.

The core model is well-tested, but not the toolkit–furrycorn is still in active development.

Compatible with Python 3.6+. Will investigate other versions on request.

Installation

pip install furrycorn should do it for your projects.

Development

Requirement setup should be a breeze using pipenv.

If you’re using nixos, simply boot a nix-shell in the project directory to get a development shell.

For the rest of the world:

  1. Clone the directory and navigate to your local repo in a command line.

  2. pipenv install --three

  3. pipenv shell

You will need to set one or two environment variables to use the examples, depending on the example. The methodology for doing this varies by OS.

For development, make sure PYTHONPATH includes the project root. Run tests with py.test.

Pleas submit changes by pull request on an aptly named topic branch.

Code Style

The author of this library prefers a functional style of coding which centers on “types”. It’s a lot easier to reason about types than logical steps, and given the highly structured nature of jsonapi, it felt like a good fit.

Feel free to message with any questions you have. I’m happy to help and explain.

License

This project is Copyright © 2018 odeum.gg and licensed under the MIT license. View the license for details.

Metadata

Release files for furrycorn 0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for furrycorn 0.7
File Size Uploaded Provenance Actions
furrycorn-0.7.tar.gz 10.4 kB Without provenance Details for furrycorn-0.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for furrycorn 0.7
File Interpreter ABI Platform Actions
furrycorn-0.7-py3-none-any.whl Python 3 none any Details for furrycorn-0.7-py3-none-any.whl

Total release size: 27.9 kB

Release files / furrycorn-0.7.tar.gz

Download URL furrycorn-0.7.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2adbceed5701df93155f54112e74b170d89b41292535a6ddfb22c2c8a8a642a8
BLAKE2b-256 checksum
How to use checksums
be5921a505659e3d09fc9355897827c493d6ff8d6efaf9c6898a8462d3b9718e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / furrycorn-0.7-py3-none-any.whl

Download URL furrycorn-0.7-py3-none-any.whl
Size 17.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ef8639f50fc83cd9c09498d77a2dbe09d1f13642acbdb8c3ce598638e451c916
BLAKE2b-256 checksum
How to use checksums
987bcc066bc4b3ad3b4a0abbbbade86b752de008da0658c1236a8b36b3ca47f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for furrycorn 0.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.7 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page