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
File details
Details for the file sweetrpg-library-objects-0.0.452.tar.gz
.
File metadata
- Download URL: sweetrpg-library-objects-0.0.452.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 434a5454d6e481cec3e9dcd3c8aa53ec50d8f6aa109c5b781e75b3cb9a921243 |
|
MD5 | deacf45ae305f72bd0cd2a9d90527bc5 |
|
BLAKE2b-256 | f0b0f46f0badc06cd00aa0352e322ecfe1df617ec9cdf18f9b7d1a17b156957c |
File details
Details for the file sweetrpg_library_objects-0.0.452-py2.py3-none-any.whl
.
File metadata
- Download URL: sweetrpg_library_objects-0.0.452-py2.py3-none-any.whl
- Upload date:
- Size: 34.1 kB
- Tags: Python 2, Python 3
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64dd2ec856ca73e2ad56c40ae8e279deda446b324efdaefc4f9ce7ee5b68751f |
|
MD5 | 0395a78cd64bf5e07aa297ae18543b45 |
|
BLAKE2b-256 | 2cd3ef4b18c73746d6c6561f100cb69b6dc24becc63366cf5ec636b7712ae45a |