Skip to main content

# sweetrpg-library-objects

[![Unit tests](https://github.com/sweetrpg/library-objects/actions/workflows/python-ci.yml/badge.svg)](https://github.com/sweetrpg/library-objects/actions/workflows/python-ci.yml) [![Coverage](https://github.com/sweetrpg/library-objects/blob/develop/coverage.svg)](https://github.com/sweetrpg/library-objects) [![PyPI version](https://badgen.net/pypi/v/sweetrpg-library-objects)](https://pypi.org/project/sweetrpg-library-objects) [![License](https://img.shields.io/github/license/sweetrpg/library-objects.svg)](https://img.shields.io/github/license/sweetrpg/library-objects.svg) [![Issues](https://img.shields.io/github/issues/sweetrpg/library-objects.svg)](https://img.shields.io/github/issues/sweetrpg/library-objects.svg) [![PRs](https://img.shields.io/github/issues-pr/sweetrpg/library-objects.svg)](https://img.shields.io/github/issues-pr/sweetrpg/library-objects.svg) [![Dependabot](https://badgen.net/github/dependabot/sweetrpg/library-objects)](https://badgen.net/github/dependabot/sweetrpg/library-objects)

[![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white) [![Built with love](https://ForTheBadge.com/images/badges/built-with-love.svg)](https://ForTheBadge.com/images/badges/built-with-love.svg)

Model package for library applications.

## Models

<a name=”#person”></a> ### Person

<a name=”#personproperty”></a> ### PersonProperty

<a name=”#publisher”></a> ### Publisher

<a name=”#review”></a> ### Review

<a name=”#studio”></a> ### Studio

<a name=”#system”></a> ### System

<a name=”#tag”></a> ### Tag

<a name=”#contribution”></a> ### Contribution

  • Fields
    • person_id: Person. Identifier of the Person making the contribution

    • roles: [Enum{ContributionType}]. An array of contribution types for this person.

      Valid values are: designer, developer, writer, artist, cartographer, editor, producer, consultant, director, illustrator, misc.

    • [Audit fields](https://github.com/sweetrpg/design/blob/master/README.md#audit).

<a name=”#volume”></a> ### Volume

  • Fields
    • name: String. The name of the volume.

    • contributors: [Contribution]. An array of contributions for the volume, indicating a person

      and their contribution(s) to the volume.

    • studio_ids: [Studio]. An array of studios associated with the volume.

    • publisher_ids: [Publisher]. An array of publishers associated with the volume.

    • system_id: System. The game system associated with the volume.

    • review_ids: [Review]. An array of reviews associated with the volume.

    • tag_ids: [Tag]. An array of tags associated with the volume.

    • [Audit fields](https://github.com/sweetrpg/design/blob/master/README.md#audit).

<a name=”#volumeproperty”></a> ### VolumeProperty

## Development

  1. Create a virtual environment

    `shell python -m venv ~/.virtualenvs/sweetrpg-library-objects source ~/.virtualenvs/sweetrpg-library-objects/bin/activate `

  2. Install requirements

    `shell pip3 install -r requirements/dev.txt `

### Requirements

Requirements are organized in a number of role-based files in the requirements/ directory:

  • dev.{in,txt} – for project development

  • pkg.{in,txt} – for the package itself

  • docs.{in,txt} – to generate documentation

  • tests.{in,txt} – to run unit tests

### Updating requirements

To update requirements, edit the appropriate *.in file, then run the update.sh script in the same directory. The script will run pip-compile to generate the *.txt file with the actual resolved versions and dependencies.

## Documentation

Documentation for this package can be found [here](https://sweetrpg.github.io/library-objects).

Metadata

Release files for sweetrpg-library-objects 0.0.452

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

Source distribution (sdist)

Source distribution for sweetrpg-library-objects 0.0.452
File Size Uploaded Provenance Actions
sweetrpg-library-objects-0.0.452.tar.gz 12.9 kB Without provenance Details for sweetrpg-library-objects-0.0.452.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sweetrpg-library-objects 0.0.452
File Interpreter ABI Platform Actions
sweetrpg_library_objects-0.0.452-py2.py3-none-any.whl Python 3, Python 2 none any Details for sweetrpg_library_objects-0.0.452-py2.py3-none-any.whl

Total release size: 47.0 kB

Release files / sweetrpg-library-objects-0.0.452.tar.gz

Download URL sweetrpg-library-objects-0.0.452.tar.gz
Size 12.9 kB
Tags Source
SHA-256 checksum
How to use checksums
434a5454d6e481cec3e9dcd3c8aa53ec50d8f6aa109c5b781e75b3cb9a921243
BLAKE2b-256 checksum
How to use checksums
f0b0f46f0badc06cd00aa0352e322ecfe1df617ec9cdf18f9b7d1a17b156957c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.11.2 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.67.0 importlib-metadata/8.5.0 keyring/25.5.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

Release files / sweetrpg_library_objects-0.0.452-py2.py3-none-any.whl

Download URL sweetrpg_library_objects-0.0.452-py2.py3-none-any.whl
Size 34.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
64dd2ec856ca73e2ad56c40ae8e279deda446b324efdaefc4f9ce7ee5b68751f
BLAKE2b-256 checksum
How to use checksums
2cd3ef4b18c73746d6c6561f100cb69b6dc24becc63366cf5ec636b7712ae45a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.11.2 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.67.0 importlib-metadata/8.5.0 keyring/25.5.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

Security for sweetrpg-library-objects 0.0.452

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.0.452 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