Metadata-Version: 2.1
Name: pixelforest-drf
Version: 0.0.dev2
Summary: A compilation of the applications we often use in addition to Django Rest Framework
Home-page: https://bitbucket.org/pixelforest/pixelforest_drf/
Author: PixelForest Dev Team
Author-email: devteam@pixelforest.io
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

PixelForest DRF
===============

This repository host the code of the PixelForest DRF package.
This package will host most of the reusable applications/code we use on
a project basis as the PixelForest Dev Team.

**Note** This package is under public licensing because we figured it
might be useful for other as it is.

Getting started
===============

Requirements
------------

The following requirements will need to be installed and configured

- [Python 3.6](https://www.python.org/downloads/release/python-360/)
- [Django](https://www.djangoproject.com/)
- [Django Rest Framework](https://www.django-rest-framework.org/)
- [PostgreSQL](https://www.postgresql.org)


Installation
------------

You can install the package using pip

```bash
    pip install pixelforest_drf
```

Contributing
============

Guidelines
----------

Please contact the [PixelForest Dev Team](devteam@pixelforest.io) for
any bug report or feature request.

Publish to PyPi
---------------
If you are not yet inside your virtual environment, activate it
```shell script
  source venv/bin/activate
```

First, generate the new distributions archives (you need `setuptools` and `wheel` installed).
```shell script
  python setup.py sdist bdist_wheel
```

Then, after testing it locally, upload it directly to PyPi. You'll need the credentials of the pixelforest PyPi user for this operation.
```shell script
  twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

Contributors
------------

**Jean-Xavier Raynaud** - [email](mailto:jx@pixelforest.io) - Product Owner / System Architect / Developer

**Milo Parigi** - [email](mailto:milo@pixelforest.io) - Scrum Master / Developer

**Victor Duvernois** - [email](mailto:victornithorynque@pixelforest.io ) -  Developer


