diff --git a/buildout.cfg b/buildout.cfg deleted file mode 100644 index 31970d1..0000000 --- a/buildout.cfg +++ /dev/null @@ -1,22 +0,0 @@ -[buildout] -parts = - python - django -develop = . -eggs = pinry - -[versions] -django = 1.5 - -[django] -recipe = djangorecipe -settings = settings.development -project = pinry -eggs = ${buildout:eggs} - -[python] -recipe = zc.recipe.egg -interpreter = py -eggs = - ${buildout:eggs} - distribute diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 5bf93c8..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,177 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pinry.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pinry.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Pinry" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pinry" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/basic_customization.rst b/docs/basic_customization.rst deleted file mode 100644 index 9695f6c..0000000 --- a/docs/basic_customization.rst +++ /dev/null @@ -1,33 +0,0 @@ -Basic Customization -=================== - - -Since we use the standard Django templating system you can edit -``pinry/templates`` and ``pinry/static`` to change the overall look and feel of -Pinry. It's all basic HTML, CSS and JS built on top of Bootstrap and some custom -JavaScript plugins, we don't provide any support for modifications to any of -this and future updates of Pinry may need to overwrite your changes so use -caution when changing the way Pinry looks. - - -Custom Settings ---------------- - -We currently have two custom settings you can change in -``pinry/settings/__init__.py``:: - - # Set to False to disable people from creating new accounts. - ALLOW_NEW_REGISTRATIONS = False - - # Set to False to force users to login before seeing any pins. - PUBLIC = True - -``ALLOW_NEW_REGISTRATIONS`` by default is set to False to prevent random people -from signing up to your Pinry, to create new private users you can use Django's -``createsuperuser``, add them to the database manually or open registrations -temporarily while you get your friends/family/coworkers to sign up. - -``PUBLIC`` by default is set to True, if you set to False users will have to -login to see any of your pins. This is a great way to create a completely -private system for a few users or just yourself. - diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 6cba7f9..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,258 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Pinry documentation build configuration file, created by -# sphinx-quickstart on Wed Sep 25 02:21:23 2013. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Pinry' -copyright = u'2013, Isaac Bythewood' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '1.3.2' -# The full version, including alpha/beta/rc tags. -release = '1.3.2' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Pinrydoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'Pinry.tex', u'Pinry Documentation', - u'Isaac Bythewood', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'pinry', u'Pinry Documentation', - [u'Isaac Bythewood'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'Pinry', u'Pinry Documentation', - u'Isaac Bythewood', 'Pinry', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False diff --git a/docs/deployment.rst b/docs/deployment.rst deleted file mode 100644 index 26c2492..0000000 --- a/docs/deployment.rst +++ /dev/null @@ -1,42 +0,0 @@ -Deployment -========== - -Deployment for a Django project is easier than most other frameworks and -languages but it's harder than a PHP project. We recommend using Docker to -deploy Pinry and we already have a Dockerfile created for you to do this. If -you'd like to deploy via another method please see `Django's documentation`_ on -the subject. - - -Notes On Deployment -------------------- - -While we don't want to go in depth on Django deployment you will need a few tips -for Pinry specific configuration. While most of Pinry acts like a standard -Django project we have a special settings setup. - -By default Django just has a single ``settings.py`` file in it's project folder, -we deviate from this in that we have a ``settings`` folder, ``pinry/settings``. -To change the base settings of Pinry you can play with -``pinry/settings/__init__.py`` but never import or run directly by pointing to -``pinry/settings`` or ``pinry/settings/__init__.py``, instead use -``pinry/settings/development.py`` and ``pinry/settings/production.py``. For a -production deployment you're going to need to edit ``production.py`` and point -that at the correct database and add your own ``SECRET_KEY``. Also note that -you're going to have to add the setting ``ALLOWED_HOSTS`` to point at the host -names going to your server or Django will block everyone trying to access your -site. - - -Using Docker ------------- - -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`_. - - -.. Links - -.. _Django's documentation: https://docs.djangoproject.com/en/1.5/howto/deployment/ -.. _docker-pinry GitHub repository: https://github.com/pinry/docker-pinry - diff --git a/docs/getting_started.rst b/docs/getting_started.rst deleted file mode 100644 index 152ce2f..0000000 --- a/docs/getting_started.rst +++ /dev/null @@ -1,44 +0,0 @@ -Getting Started -=============== - -Below are the most basic requirements and a small test to make sure everything -is running properly before you get into the heavy lifting. Alternatively you can -skip to deployment and use our Dockerfile that will build and run everything for -you! - - -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 -* virtualenv -* pip -* Pillow build dependencies or the most recent version installed on your OS and - use ``virtualenv --system-site-packages`` when initiating virtualenv. -* Node -* Bower - -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 - diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 2697389..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -Pinry |release| -=============== - -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. - - -Documentation -------------- - -.. toctree:: - :maxdepth: 2 - - getting_started - basic_customization - running_on - deployment - - -Useful Links ------------- - -* Get Pinry: http://getpinry.com/ -* About Pinry: http://getpinry.com/about/ -* Pinry Demo: http://demo.getpinry.com/ -* Pinry Issues: https://github.com/pinry/pinry/issues -* pinry/pinry: https://github.com/pinry/pinry -* pinry/docker-pinry: https://github.com/pinry/docker-pinry -* pinry/getpinry.com: https://github.com/pinry/getpinry.com - diff --git a/docs/running_on.rst b/docs/running_on.rst deleted file mode 100644 index bfa4662..0000000 --- a/docs/running_on.rst +++ /dev/null @@ -1,42 +0,0 @@ -Running On... -============= - -The system that we use and recommend you running Pinry on is Ubuntu. That being -said we provide buildout configs and pay very close attention to all other -operating systems, you should be able to develop/test/deploy pinry on every -platform, we just don't give support for them. - - -Ubuntu ------- - -Ubuntu is pretty simple to get Pinry running get some of our required packages -first:: - - sudo apt-get install python-virtualenv git npm - sudo apt-get build-dep python-imaging - sudo npm install -g bower - -Then you'll need to get Pinry and setup our virtualenv:: - - git clone https://github.com/pinry/pinry.git - cd pinry - virtualenv . - bower install - bin/pip install -r requirements.txt - -From here you have a full working install of Pinry! You can: - -* Run some tests: ``bin/python manage.py test`` -* Run a development server: ``bin/python manage.py runserver`` -* Edit the settings files: ``pinry/settings`` -* Customize the theme: ``pinry/templates`` + ``pinry/static`` - - -Database Notes --------------- - -When setting up for the first time you'll need to run syncdb and migrations -because we use South:: - - bin/python manage.py syncdb --migrate diff --git a/setup.py b/setup.py deleted file mode 100644 index b1139cb..0000000 --- a/setup.py +++ /dev/null @@ -1,42 +0,0 @@ -import os -from setuptools import setup, find_packages - - -def read(fname): - return open(os.path.join(os.path.dirname(__file__), fname)).read() - - -install_requires = [ - 'Django', - 'Pillow', - 'South', - 'requests', - 'django-taggit', - 'django-images', - 'django-braces', - 'django_compressor', - 'django-tastypie==0.9.14', -] - -setup( - name="pinry", - version="1.3.2", - author="Pinry Contributors", - author_email="devs@getpinry.com", - description=("A tiling image board system for people who want to save, " - "tag, and share images, videos and webpages."), - license="Simplified BSD", - keywords="django tiling board tag share images pictures videos webpages", - url="http://getpinry.com/", - packages=find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]), - long_description=read('README.rst'), - tests_require=['mock', 'factory-boy>=1.3,<2.0'], - install_requires=install_requires, - classifiers=[ - "Development Status :: 5 - Production/Stable", - "License :: OSI Approved :: BSD License", - "Framework :: Django", - "Environment :: Web Environment", - ], -) -