Permalink
Browse files

Initial commit

  • Loading branch information...
0 parents commit f989a757373ca402fc13c61bf1b8073f4d756013 @willkg committed Sep 26, 2012
@@ -0,0 +1,6 @@
+*.py[oc]
+build/
+dist/
+*.egg-info
+docs/_build
+*~
@@ -0,0 +1,18 @@
+======================
+ What's new in Eadred
+======================
+
+.. contents::
+ :local:
+
+
+Version 0.1: in development
+===========================
+
+**API-breaking changes:**
+
+None
+
+**Changes**
+
+* Initial writing.
@@ -0,0 +1,8 @@
+==============
+ Contributors
+==============
+
+* Will Kahn-Greene
+* Reiner Gerecke
+* Mike Cooper
+* James Socol
@@ -0,0 +1,30 @@
+Copyright (c) 2012 Will Kahn-Greene
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+
+ Neither the name of the <ORGANIZATION> nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 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 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,4 @@
+include README.rst CHANGELOG LICENSE CONTRIBUTORS
+include requirements*.txt
+include docs/Makefile docs/conf.py
+recursive-include docs *.rst *.py
@@ -0,0 +1,69 @@
+========
+ README
+========
+
+eadred is a Django-app for generating sample data.
+
+Why? Here are the use cases we're solving:
+
+**Use Case 1: Contributors**
+
+ Mildred wants to contribute to your Django project, but your
+ Django project is non-trivial and out of the box it's not very
+ usable because it needs data.
+
+ However, you're using eadred, so in your setup documentation, you
+ have a one-liner that generates all the sample data Mildred needs
+ to start hacking immediately.
+
+**Use Case 2: Bootstrapping**
+
+ Willhelm wants to set up an instance of your Django project. It
+ requires certain non-trivial initial data to be in place before it
+ works.
+
+ However, you're using eadred, so in your setup documentation, you
+ have a one-liner that generates all the initial data needed.
+
+**Use Case 3: Large amounts of random data**
+
+ Phylida is a hacker on your Django project and trying to fix bugs
+ with a section of code that requires large amounts of data---say
+ it's one of those things that graphs data sets or something.
+
+ You're using eadred, so it's a one-liner to generate a large set
+ of initial data.
+
+
+"Wait, use cases 1 and 2 are easily solved with Django and fixtures!"
+
+I think fixtures are good for specific use cases where your models
+aren't changing and you have some contributor who likes entering in
+data to build the initial fixtures. Having said that, I don't use
+fixtures.
+
+eadred allows you to programmatically generate the data using model
+makers, factories, fixtures, random seeds---whatever your needs are.
+
+Additionally, eadred provides library functions to make generating
+data easier.
+
+
+Project details
+===============
+
+Code:
+ http://github.com/willkg/django-eadred
+
+Documentation:
+ http://django-eadred.rtfd.org/
+
+Issue tracker:
+ https://github.com/willkg/django-eadred/issues
+
+IRC:
+ #eadred on freenode.net
+
+License:
+ BSD 3-clause; see LICENSE file
+
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# 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 <target>' where <target> 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 " 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 " 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/eadred.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/eadred.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/eadred"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/eadred"
+ @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."
+
+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."
@@ -0,0 +1,49 @@
+==============
+ About eadred
+==============
+
+eadred is a Django-app for generating sample data.
+
+Why? Here are the use cases we're solving:
+
+**Use Case 1: Contributors**
+
+ Mildred wants to contribute to your Django project, but your
+ Django project is non-trivial and out of the box it's not very
+ usable because it needs data.
+
+ However, you're using eadred, so in your setup documentation, you
+ have a one-liner that generates all the sample data Mildred needs
+ to start hacking immediately.
+
+**Use Case 2: Bootstrapping**
+
+ Willhelm wants to set up an instance of your Django project. It
+ requires certain non-trivial initial data to be in place before it
+ works.
+
+ However, you're using eadred, so in your setup documentation, you
+ have a one-liner that generates all the initial data needed.
+
+**Use Case 3: Large amounts of random data**
+
+ Phylida is a hacker on your Django project and trying to fix bugs
+ with a section of code that requires large amounts of data---say
+ it's one of those things that graphs data sets or something.
+
+ You're using eadred, so it's a one-liner to generate a large set
+ of initial data.
+
+
+"Wait, use cases 1 and 2 are easily solved with Django and fixtures!"
+
+I think fixtures are good for specific use cases where your models
+aren't changing and you have some contributor who likes entering in
+data to build the initial fixtures. Having said that, I don't use
+fixtures.
+
+eadred allows you to programmatically generate the data using model
+makers, factories, fixtures, random seeds---whatever your needs are.
+
+Additionally, eadred provides library functions to make generating
+data easier.
@@ -0,0 +1 @@
+.. include:: ../CHANGELOG
Oops, something went wrong.

0 comments on commit f989a75

Please sign in to comment.