No project description provided
Project description
# 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
- 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
- Create a virtual environment
`shell python -m venv ~/.virtualenvs/sweetrpg-library-objects source ~/.virtualenvs/sweetrpg-library-objects/bin/activate `
- 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).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sweetrpg-library-objects-0.0.236.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7f0111ef11ad2373bd0d612ddf6331f8a0a3f463922a2ede8ba4928a8981737 |
|
MD5 | a4130950f46496627250ab65b68e815a |
|
BLAKE2b-256 | 69ccfd7e4764ee3533aa393e68de8e46bf606610dbef2f12d09aa9697fbf0ac9 |
Hashes for sweetrpg_library_objects-0.0.236-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 875ca71e4cf38575e9f86071eaa67468b9f9bd63d9ac858421d62c4b3b498223 |
|
MD5 | 15053656f6f554fa0bcea126c435d814 |
|
BLAKE2b-256 | e1e8ce53ac0e51647b5de848c3b795a742c19da1fcfcb58b4859f44ef5c83419 |