Skip to main content

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

<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=”#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

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

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

sweetrpg-library-objects-0.0.51.tar.gz (11.0 kB view hashes)

Uploaded Source

Built Distribution

sweetrpg_library_objects-0.0.51-py2.py3-none-any.whl (33.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page