sweetrpg-library-objects 0.0.255

No project description provided

# sweetrpg-library-objects

[](https://github.com/sweetrpg/library-objects/actions/workflows/python-ci.yml) [](https://github.com/sweetrpg/library-objects) [](https://pypi.org/project/sweetrpg-library-objects) [](https://img.shields.io/github/license/sweetrpg/library-objects.svg) [](https://img.shields.io/github/issues/sweetrpg/library-objects.svg) [](https://img.shields.io/github/issues-pr/sweetrpg/library-objects.svg) [](https://badgen.net/github/dependabot/sweetrpg/library-objects)

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

Model package for library applications.

## Models

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

• Fields

  • name: String. The name of the person.

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

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

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

• Fields

  • name: String. The name of the property.

  • type: String. The type of the property’s value.

  • value: String. The value of the property.

  • person_id: Volume. The identifier of the person associated with the property.

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

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

• Fields

  • name: String. The name of the publisher.

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

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

• Fields

  • title: String. The title of the review.

  • text: String. The body text of the review.

  • volume_id: Volume. The volume associated with the review.

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

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

• Fields

  • name: String. The name of the studio.

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

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

• Fields

  • game_system: String. The identifier of the game system.

  • edition: String. The identifier of the game system’s edition.

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

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

• Fields

  • name: String. The name of the tag.

  • value: String. The optional value of the tag.

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

<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

• Fields

  • name: String. The name of the property.

  • type: String. The type of the property’s value.

  • value: String. The value of the property.

  • volume_id: Volume. The identifier of the volume associated with the property.

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

## 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).