An open API service indexing awesome lists of open source software.

https://github.com/wooyek/picropper

Web application to prepare images in predefined sizes
https://github.com/wooyek/picropper

Last synced: 4 months ago
JSON representation

Web application to prepare images in predefined sizes

Awesome Lists containing this project

README

        

=========
Picropper
=========

Web application to prepare images in predefined sizes

.. image:: https://img.shields.io/pypi/v/picropper.svg
:target: https://pypi.python.org/pypi/picropper

.. image:: https://img.shields.io/travis/wooyek/picropper.svg
:target: https://travis-ci.org/wooyek/picropper

.. image:: https://readthedocs.org/projects/picropper/badge/?version=latest
:target: https://picropper.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://coveralls.io/repos/github/wooyek/picropper/badge.svg?branch=develop
:target: https://coveralls.io/github/wooyek/picropper?branch=develop
:alt: Coveralls.io coverage

.. image:: https://codecov.io/gh/wooyek/picropper/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/wooyek/picropper
:alt: CodeCov coverage

.. image:: https://api.codeclimate.com/v1/badges/0e7992f6259bc7fd1a1a/maintainability
:target: https://codeclimate.com/github/wooyek/picropper/maintainability
:alt: Maintainability

.. image:: https://img.shields.io/github/license/wooyek/picropper.svg
:target: https://github.com/wooyek/picropper/blob/develop/LICENSE
:alt: License

.. image:: https://img.shields.io/twitter/url/https/github.com/wooyek/picropper.svg?style=social
:target: https://twitter.com/intent/tweet?text=Wow:&url=https://github.com/wooyek/picropper
:alt: Tweet about this project

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
:target: https://saythanks.io/to/wooyek

* Free software: GNU General Public License v3
* Documentation: https://picropper.readthedocs.io.

Features
--------

* Pending :D

Demo
----

To run an example project for this django reusable app, click the button below and start a demo serwer on Heroku

.. image:: https://www.herokucdn.com/deploy/button.png
:target: https://heroku.com/deploy
:alt: Deploy Django Opt-out example project to Heroku

Quickstart
----------

1. Fork the `picropper` repo on bitbucket.org
2. Clone your fork locally::

$ git clone [email protected]:wooyek/picropper.git

3. Setup your development env::

$ pipsi install pew
$ cd picropper/
$ pew new -p python3 -a $(pwd) $(pwd | xargs basename)
$ pew workon picropper
$ pip install -r requirements/development.txt

4. Test project health::

$ python manage.py check
$ pytest
$ inv check
$ tox

5. Initialize development database and fill it with test data::

$ bash bin/database_create.sh
$ inv db

6. Create a branch for local development and start development server::

$ git checkout -b name-of-your-bugfix-or-feature
$ python manage.py runserver

Deployment
----------

Add a development remote and deploy::

$ git remote add dev https://git.heroku.com/picropper-dev.git
$ inv deploy

Credits
-------

This package was created with Cookiecutter_ and the `wooyek/cookiecutter-django-app`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`wooyek/cookiecutter-django-app`: https://github.com/wooyek/cookiecutter-django-app
.. _`pipenv`: https://docs.pipenv.org/install