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=”#author”></a> ### Author
[Slug as identifier](https://github.com/sweetrpg/design/blob/master/README.md#slug).
- Fields
name: String. The name of the author.
tags: [Tag]. An array of tags associated with the author.
[Audit fields](https://github.com/sweetrpg/design/blob/master/README.md#audit).
<a name=”#publisher”></a> ### Publisher
[Slug as identifier](https://github.com/sweetrpg/design/blob/master/README.md#slug).
- 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: Volume. The volume associated with the review.
[Audit fields](https://github.com/sweetrpg/design/blob/master/README.md#audit).
<a name=”#studio”></a> ### Studio
[Slug as identifier](https://github.com/sweetrpg/design/blob/master/README.md#slug).
- 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
[Slug as identifier](https://github.com/sweetrpg/design/blob/master/README.md#slug).
- Fields
gameSystemIdentifier: String. The identifier of the game system.
editionIdentifier: String. The identifier of the game system’s edition.
volumes: [Volume]: An array of volumes belonging to the game system.
[Audit fields](https://github.com/sweetrpg/design/blob/master/README.md#audit).
<a name=”#tag”></a> ### Tag
- Fields
name: String. The text of the tag.
[Audit fields](https://github.com/sweetrpg/design/blob/master/README.md#audit).
<a name=”#volume”></a> ### Volume
[Slug as identifier](https://github.com/sweetrpg/design/blob/master/README.md#slug).
- Fields
name: String. The name of the volume.
isbn: String. ISBN number for the volume.
authors: [Author]. An array of authors associated with the volume.
studios: [Studio]. An array of studios associated with the volume.
publishers: [Publisher]. An array of publishers associated with the volume.
system: System. The game system associated with the volume.
reviews: [Review]. An array of reviews associated with the volume.
tags: [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: Volume. 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.31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ef573fdf97078d570452253dfcd05cbe17690ef5ed2419b46411150e8ccccc9 |
|
MD5 | f9927ce99e8ded22a21b4d7684694115 |
|
BLAKE2b-256 | 6db3a1abb29bf5022d26d1d98eddeb097d0469639e16c8fbd02baaffaeb8b1be |
Hashes for sweetrpg_library_objects-0.0.31-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a4aa1e36a6fa28a1d3ab34d3b8ebac98a6f11a417d0f680b8de758944e73882 |
|
MD5 | 2c4c37e2e806f352a541090de0b07030 |
|
BLAKE2b-256 | 55f4727c10902d97d3c7090f504002735abe0be52be0c8ef90a32dc975f000f1 |