Permalink
Browse files

initialise the package structure

  • Loading branch information...
xiaoganghan committed Feb 11, 2014
1 parent c10efcc commit 3cd367c1d0b109c316fe3a821a00f3a211e1c103
Showing with 1,095 additions and 12,135 deletions.
  1. +42 −1 .gitignore
  2. +13 −0 AUTHORS.rst
  3. +111 −0 CONTRIBUTING.rst
  4. +9 −0 HISTORY.rst
  5. +12 −0 LICENSE
  6. +5 −0 MANIFEST.in
  7. +54 −0 Makefile
  8. +0 −22 README
  9. +0 −27 README.md
  10. +23 −0 README.rst
  11. +177 −0 docs/Makefile
  12. +1 −0 docs/authors.rst
  13. +260 −0 docs/conf.py
  14. +1 −0 docs/contributing.rst
  15. +1 −0 docs/history.rst
  16. +26 −0 docs/index.rst
  17. +12 −0 docs/installation.rst
  18. +242 −0 docs/make.bat
  19. +1 −0 docs/readme.rst
  20. +7 −0 docs/usage.rst
  21. +1 −0 requirements.txt
  22. +50 −0 setup.py
  23. BIN source/.DS_Store
  24. +0 −2,012 source/BeautifulSoup.py
  25. BIN source/BeautifulSoup.pyc
  26. +0 −27 source/__init__.py
  27. +0 −84 source/app.py
  28. +0 −11 source/app.yaml
  29. +0 −225 source/bitly.py
  30. BIN source/bitly.pyc
  31. +0 −5 source/cron.yaml
  32. +0 −2,858 source/feedparser.py
  33. BIN source/feedparser.pyc
  34. +0 −11 source/index.yaml
  35. +0 −18 source/local_settings.py
  36. BIN source/local_settings.pyc
  37. +0 −316 source/simplejson/__init__.py
  38. BIN source/simplejson/__init__.pyc
  39. +0 −2,265 source/simplejson/_speedups.c
  40. +0 −348 source/simplejson/decoder.py
  41. BIN source/simplejson/decoder.pyc
  42. +0 −436 source/simplejson/encoder.py
  43. BIN source/simplejson/encoder.pyc
  44. +0 −65 source/simplejson/scanner.py
  45. BIN source/simplejson/scanner.pyc
  46. +0 −35 source/simplejson/tool.py
  47. +0 −60 source/test.py
  48. +0 −27 source/tweepy/__init__.py
  49. BIN source/tweepy/__init__.pyc
  50. +0 −740 source/tweepy/api.py
  51. BIN source/tweepy/api.pyc
  52. +0 −156 source/tweepy/auth.py
  53. BIN source/tweepy/auth.pyc
  54. +0 −213 source/tweepy/binder.py
  55. BIN source/tweepy/binder.pyc
  56. +0 −424 source/tweepy/cache.py
  57. BIN source/tweepy/cache.pyc
  58. +0 −171 source/tweepy/cursor.py
  59. BIN source/tweepy/cursor.pyc
  60. +0 −15 source/tweepy/error.py
  61. BIN source/tweepy/error.pyc
  62. +0 −432 source/tweepy/models.py
  63. BIN source/tweepy/models.pyc
  64. +0 −655 source/tweepy/oauth.py
  65. BIN source/tweepy/oauth.pyc
  66. +0 −97 source/tweepy/parsers.py
  67. BIN source/tweepy/parsers.pyc
  68. +0 −319 source/tweepy/streaming.py
  69. BIN source/tweepy/streaming.pyc
  70. +0 −60 source/tweepy/utils.py
  71. BIN source/tweepy/utils.pyc
  72. +2 −0 tests/__init__.py
  73. +28 −0 tests/test_twitter-bot.py
  74. +9 −0 tox.ini
  75. +6 −0 twitter-bot/__init__.py
  76. +2 −0 twitter-bot/twitter-bot.py
View
@@ -1 +1,42 @@
-.DS_Store*.pyclocal_settings.py
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
View
@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Xiaogang Han <xganghan@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?
View
@@ -0,0 +1,111 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/chrishan/twitter-bot/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+twitter-bot could always use more documentation, whether as part of the
+official twitter-bot docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/chrishan/twitter-bot/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+ are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `twitter-bot` for local development.
+
+1. Fork the `twitter-bot` repo on GitHub.
+2. Clone your fork locally::
+
+ $ git clone git@github.com:your_name_here/twitter-bot.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+ $ mkvirtualenv twitter-bot
+ $ cd twitter-bot/
+ $ python setup.py develop
+
+4. Create a branch for local development::
+
+ $ git checkout -b name-of-your-bugfix-or-feature
+
+ Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+ $ flake8 twitter-bot tests
+ $ python setup.py test
+ $ tox
+
+ To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+ $ git add .
+ $ git commit -m "Your detailed description of your changes."
+ $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+ your new functionality into a function with a docstring, and add the
+ feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
+ https://travis-ci.org/chrishan/twitter-bot/pull_requests
+ and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+ $ python -m unittest tests.test_twitter-bot
View
@@ -0,0 +1,9 @@
+.. :changelog:
+
+History
+-------
+
+0.1.0 (2014-02-11)
+++++++++++++++++++
+
+* First release on PyPI.
View
12 LICENSE
@@ -0,0 +1,12 @@
+Copyright (c) 2014, Xiaogang Han
+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 twitter-bot 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.
View
@@ -0,0 +1,5 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
View
@@ -0,0 +1,54 @@
+.PHONY: clean-pyc clean-build docs
+
+help:
+ @echo "clean-build - remove build artifacts"
+ @echo "clean-pyc - remove Python file artifacts"
+ @echo "lint - check style with flake8"
+ @echo "test - run tests quickly with the default Python"
+ @echo "testall - run tests on every Python version with tox"
+ @echo "coverage - check code coverage quickly with the default Python"
+ @echo "docs - generate Sphinx HTML documentation, including API docs"
+ @echo "release - package and upload a release"
+ @echo "sdist - package"
+
+clean: clean-build clean-pyc
+
+clean-build:
+ rm -fr build/
+ rm -fr dist/
+ rm -fr *.egg-info
+
+clean-pyc:
+ find . -name '*.pyc' -exec rm -f {} +
+ find . -name '*.pyo' -exec rm -f {} +
+ find . -name '*~' -exec rm -f {} +
+
+lint:
+ flake8 twitter-bot tests
+
+test:
+ python setup.py test
+
+test-all:
+ tox
+
+coverage:
+ coverage run --source twitter-bot setup.py test
+ coverage report -m
+ coverage html
+ open htmlcov/index.html
+
+docs:
+ rm -f docs/twitter-bot.rst
+ rm -f docs/modules.rst
+ sphinx-apidoc -o docs/ twitter-bot
+ $(MAKE) -C docs clean
+ $(MAKE) -C docs html
+ open docs/_build/html/index.html
+
+release: clean
+ python setup.py sdist upload
+
+sdist: clean
+ python setup.py sdist
+ ls -l dist
View
22 README
@@ -1,22 +0,0 @@
-# Dumps hot links instead of new links on programming.reddit only after they've got more than 5 comments.
-
-## Get started
-
-### create a file named local_settings.py in the 'source' dir, and fill up the entries with the keys obtained from Twitter and Bitly
-
-```python
-TwitterKey = {
- 'consumer_key': "",
- 'consumer_secret': "",
- 'access_token': "",
- 'access_token_secret': ""
- }
-
-BitlyKey = {
- 'login': '',
- 'apikey': ''
- }
-
-```
-
-### change appname in app.yaml to the name of your app on appengine
View
@@ -1,27 +0,0 @@
-Dumps hot links instead of new links on programming.reddit only after they've got more than 5 comments.
-
-Get started
-===========
-
-create a file named local_settings.py in the 'source' dir, and copy and parse the following code with the keys obtained from Twitter and Bitly.
-
-```python
-TwitterKey = {
- 'consumer_key': "",
- 'consumer_secret': "",
- 'access_token': "",
- 'access_token_secret': ""
- }
-
-BitlyKey = {
- 'login': '',
- 'apikey': ''
- }
-
-```
-
-change appname in app.yaml to the name of your app on appengine.
-
-License
-=======
-Apache 2.0
View
@@ -0,0 +1,23 @@
+===============================
+twitter-bot
+===============================
+
+.. image:: https://badge.fury.io/py/twitter-bot.png
+ :target: http://badge.fury.io/py/twitter-bot
+
+.. image:: https://travis-ci.org/chrishan/twitter-bot.png?branch=master
+ :target: https://travis-ci.org/chrishan/twitter-bot
+
+.. image:: https://pypip.in/d/twitter-bot/badge.png
+ :target: https://crate.io/packages/twitter-bot?version=latest
+
+
+twitter bot
+
+* Free software: BSD license
+* Documentation: http://twitter-bot.rtfd.org.
+
+Features
+--------
+
+* TODO
Oops, something went wrong.

0 comments on commit 3cd367c

Please sign in to comment.