mirror of
https://github.com/pinry/pinry.git
synced 2025-11-17 18:30:39 +01:00
Moving to RST to be more pythonic
This commit is contained in:
@@ -1,6 +0,0 @@
|
|||||||
# Contributors
|
|
||||||
|
|
||||||
The core contributors for Pinry have been/currently are:
|
|
||||||
|
|
||||||
* Isaac Bythewood <http://isaacbythewood.com/>
|
|
||||||
* Krzysztof Klimonda
|
|
||||||
8
CONTRIBUTORS.rst
Normal file
8
CONTRIBUTORS.rst
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
Contributors
|
||||||
|
============
|
||||||
|
|
||||||
|
The core contributors for Pinry have been/currently are:
|
||||||
|
|
||||||
|
* Isaac Bythewood <http://isaacbythewood.com/>
|
||||||
|
* Krzysztof Klimonda
|
||||||
|
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
# License (Simplified BSD)
|
License (Simplified BSD)
|
||||||
|
========================
|
||||||
|
|
||||||
Copyright (c) Pinry Contributors
|
| Copyright (c) Pinry Contributors
|
||||||
All rights reserved.
|
| All rights reserved.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
Redistribution and use in source and binary forms, with or without
|
||||||
modification, are permitted provided that the following conditions are met:
|
modification, are permitted provided that the following conditions are met:
|
||||||
@@ -23,3 +24,4 @@ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|||||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
59
README.md
59
README.md
@@ -1,59 +0,0 @@
|
|||||||
# 
|
|
||||||
|
|
||||||
The open-source core of Pinry, a tiling image board system for people who
|
|
||||||
want to save, tag, and share images, videos and webpages in an easy to skim
|
|
||||||
through format.
|
|
||||||
|
|
||||||
For more information and a working demo board visit
|
|
||||||
[getpinry.com](http://getpinry.com/).
|
|
||||||
|
|
||||||
For the latest documentation check out
|
|
||||||
[Read the Docs](http://pinry.readthedocs.org/).
|
|
||||||
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
Pinry is built on top of Django and optimized to run on a Linux environment.
|
|
||||||
However we have gotten Pinry to work on Windows and Mac as well but it may
|
|
||||||
require some extra digging around configuration. Pinry's Python requirements are
|
|
||||||
all in the `requirements.txt` file and easily installable once you have up a
|
|
||||||
virtual environment. What you need initially:
|
|
||||||
|
|
||||||
* Python
|
|
||||||
* pip
|
|
||||||
* virtualenv
|
|
||||||
* Your OS's build tools (Ubuntu: `build-essential`, Mac: `Xcode`)
|
|
||||||
* Build dependencies for PIL/Pillow (Ubuntu: `apt-get build-dep python-imaging`)
|
|
||||||
|
|
||||||
After you have all of the above you can skip to Testing and make sure it all
|
|
||||||
works.
|
|
||||||
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
We have many tests built into Pinry to ensure that changes don't break anything.
|
|
||||||
If you are live dangerously and have cutting edge new Pinry features first you
|
|
||||||
can use our master branch for your own instance. We recommend using our
|
|
||||||
tags/versions though.
|
|
||||||
|
|
||||||
To run Pinry's tests inside the Pinry repo run:
|
|
||||||
|
|
||||||
virtualenv .
|
|
||||||
bin/pip install -r requirements.txt
|
|
||||||
bin/python manage.py test
|
|
||||||
|
|
||||||
|
|
||||||
## Production Deployment
|
|
||||||
|
|
||||||
Our supported and suggested way to deploy Pinry is using Docker. We provide
|
|
||||||
support and instructions for that over at the
|
|
||||||
[docker-pinry GitHub repository](https://github.com/pinry/docker-pinry).
|
|
||||||
|
|
||||||
If you'd like a different setup then check out the hundreds of tutorials
|
|
||||||
for production Django deployment found via Google.
|
|
||||||
|
|
||||||
|
|
||||||
## Current Master Build Status
|
|
||||||
|
|
||||||
[ ](https://www.codeship.io/projects/2005)
|
|
||||||
|
|
||||||
70
README.rst
Normal file
70
README.rst
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
|Pinry|
|
||||||
|
=======
|
||||||
|
|
||||||
|
The open-source core of Pinry, a tiling image board system for people
|
||||||
|
who want to save, tag, and share images, videos and webpages in an easy
|
||||||
|
to skim through format.
|
||||||
|
|
||||||
|
For more information and a working demo board visit `getpinry.com`_. For the
|
||||||
|
latest documentation check out `Read the Docs`_.
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
Pinry is built on top of Django and optimized to run on a Linux
|
||||||
|
environment. However we have gotten Pinry to work on Windows and Mac as
|
||||||
|
well but it may require some extra digging around configuration. Pinry's
|
||||||
|
Python requirements are all in the ``requirements.txt`` file and easily
|
||||||
|
installable once you have up a virtual environment. What you need
|
||||||
|
initially:
|
||||||
|
|
||||||
|
* Python
|
||||||
|
* pip
|
||||||
|
* virtualenv
|
||||||
|
* Your OS's build tools (Ubuntu: ``build-essential``, Mac: ``Xcode``)
|
||||||
|
* Build dependencies for PIL/Pillow (Ubuntu:
|
||||||
|
``apt-get build-dep python-imaging``)
|
||||||
|
|
||||||
|
|
||||||
|
Testing
|
||||||
|
-------
|
||||||
|
|
||||||
|
We have many tests built into Pinry to ensure that changes don't break
|
||||||
|
anything. If you are live dangerously and have cutting edge new Pinry
|
||||||
|
features first you can use our master branch for your own instance. We
|
||||||
|
recommend using our tags/versions though.
|
||||||
|
|
||||||
|
To run Pinry's tests inside the Pinry repo run::
|
||||||
|
|
||||||
|
virtualenv .
|
||||||
|
bin/pip install -r requirements.txt
|
||||||
|
bin/python manage.py test
|
||||||
|
|
||||||
|
|
||||||
|
Production Deployment
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Our supported and suggested way to deploy Pinry is using Docker. We
|
||||||
|
provide support and instructions for that over at the `docker-pinry
|
||||||
|
GitHub repository`_.
|
||||||
|
|
||||||
|
If you'd like a different setup then check out the hundreds of tutorials
|
||||||
|
for production Django deployment found via Google.
|
||||||
|
|
||||||
|
|
||||||
|
Current Master Build Status
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
|Codeship Status for pinry/pinry|
|
||||||
|
|
||||||
|
|
||||||
|
.. Links
|
||||||
|
|
||||||
|
.. |Pinry| image:: https://raw.github.com/pinry/pinry/master/logo.png
|
||||||
|
.. |Codeship Status for pinry/pinry| image:: https://www.codeship.io/projects/461ebc50-70be-0130-073a-22000a9d07d8/status?branch=master
|
||||||
|
:target: https://www.codeship.io/projects/2005
|
||||||
|
.. _getpinry.com: http://getpinry.com/
|
||||||
|
.. _Read the Docs: http://pinry.readthedocs.org/
|
||||||
|
.. _docker-pinry GitHub repository: https://github.com/pinry/docker-pinry
|
||||||
|
|
||||||
2
setup.py
2
setup.py
@@ -29,7 +29,7 @@ setup(
|
|||||||
keywords="django tiling board tag share images pictures videos webpages",
|
keywords="django tiling board tag share images pictures videos webpages",
|
||||||
url="http://getpinry.com/",
|
url="http://getpinry.com/",
|
||||||
packages=find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
|
packages=find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
|
||||||
long_description=read('README.md'),
|
long_description=read('README.rst'),
|
||||||
dependency_links=dependency_links,
|
dependency_links=dependency_links,
|
||||||
tests_require=['mock', 'factory-boy>=1.3,<2.0'],
|
tests_require=['mock', 'factory-boy>=1.3,<2.0'],
|
||||||
install_requires=install_requires,
|
install_requires=install_requires,
|
||||||
|
|||||||
Reference in New Issue
Block a user