Skip to main content

Python implementation of a REST based storage

Project description

.. -*- coding: utf-8; mode: rst; -*-
.. Pyreststore introduction https://github.com/peterdv/pyreststore

.. To be able to generate PDF files, install the texlive-latex-extra package

.. For the Python documentation,
this convention is used which you may follow:
• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• ", for paragraphs


Pyreststore introduction
========================

.. image:: https://travis-ci.org/peterdv/pyreststore.svg?branch=master
:target: https://travis-ci.org/peterdv/pyreststore

`Pyreststore`_ is a `Python`_ implementation of a `REST`_ based storage,
a web application capable of storing bitbuckets serialized as plain text.
This is a varation of the `pastebin type`_ web applications implemented in
`Python`_ on top of `Django`_ and the associated `Django REST framework`_.

.. _`Pyreststore`: https://github.com/peterdv/pyreststore
.. _`Python`: https://www.python.org/
.. _`REST`: https://en.wikipedia.org/wiki/Representational_state_transfer
.. _`pastebin type`: https://en.wikipedia.org/wiki/Pastebin
.. _`Django`: https://www.djangoproject.com/
.. _`Django REST framework`: http://tomchristie.github.io/django-rest-framework/

Plenty of fine pastebin applications exist, so why create yet another one ?
The answer is quite simply: because I could.
Professionally I found myself in need of an
enterprise level, internal pastebin service,
and none of the existing ones I considered did quite fit the bill.
This, in combination with a summer vacation cumming up,
made the decission to roll my own -
and dig into Django along the way - an easy decission.

So pyreststore is used to fill a very specific need we had
in our systems landscape,
and at the same time it is a personal learning experience for me.
The implementation is inspired of my starting points learning about
Django and Rest: The excelent `Django REST framwork Tutorial`_
and `Django Tutorial`_,
without those I would not have embarked on this journey.

.. _`Django REST framwork Tutorial`: http://tomchristie.github.io/django-rest-framework/#tutorial
.. _`Django Tutorial`: https://docs.djangoproject.com/en/1.8/intro/tutorial01/

If You consider using this code, please remember that it was implemented
specifically for the two purposes stated above.
You should carefully consider which support level You need,
adopting this code implies that You will maintain the code yourself !
If You are capable and willing to do this, please dig in - and consider
contributing here.
We have a single enterprise deployment of a slightly adapted version of
pyreststore, but I do not have ressources to support pyreststore in general.

If You decide to go ahead, please read the `License`_ file,
it should be wide enough to fit most purposes,
and consult the `installation`_ notes.

.. _`License`: ./LICENSE
.. _`installation`: doc/installation.rst

I sincerely hope that You have as much fun as I have had !

`Peter Dahl Vestergaard`_

.. _`Peter Dahl Vestergaard`: https://dk.linkedin.com/in/peterdahlvestergaard

.. include:: doc/installation.rst

.. EOF

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyreststore-0.9.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

pyreststore-0.9.0-py2-none-any.whl (11.4 kB view details)

Uploaded Python 2

File details

Details for the file pyreststore-0.9.0.tar.gz.

File metadata

  • Download URL: pyreststore-0.9.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyreststore-0.9.0.tar.gz
Algorithm Hash digest
SHA256 e257dc95445b73eb9ee0e3150f2987a36057e18b10cec9b6895eb2a71f20cc84
MD5 1ef4f3b6b88ad53d7886f6e2f80987a4
BLAKE2b-256 50828ae6bd12fa83513ed65aec642d4024a034cb71da16cffe5c923db7d441a2

See more details on using hashes here.

File details

Details for the file pyreststore-0.9.0-py2-none-any.whl.

File metadata

File hashes

Hashes for pyreststore-0.9.0-py2-none-any.whl
Algorithm Hash digest
SHA256 c87037f5cc9e9161c76bc6f868325df7ad4793b07235b3ed95e4cb83672e309f
MD5 1b25f27abda98918af11d7f1f9e4254a
BLAKE2b-256 4e89b3b9ad259febc083d09f4c7ab1d6225b8f6a3a1973bdce580457acd52b33

See more details on using hashes here.

Supported by

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