Skip to content

Commit 9df386d

Browse files
committed
finish the documentaton partially
1 parent a5b0c84 commit 9df386d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+3554
-1331
lines changed

README.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
PastebinPython
2+
**************
3+
4+
A complete http://pastebin.com API wrapper for Python
5+
6+
Sample Usage
7+
============
8+
::
9+
"""
10+
Creating paste from file...
11+
12+
"""
13+
from pastebin_python import PastebinPython
14+
from pastebin_python.pastebin_exceptions import PastebinBadRequestException, PastebinNoPastesException, PastebinFileException
15+
from pastebin_python.pastebin_constants import PASTE_PUBLIC, EXPIRE_10_MIN
16+
from pastebin_python.pastebin_formats import FORMAT_NONE, FORMAT_PYTHON, FORMAT_HTML
17+
18+
pbin = PastebinPython(api_dev_key='<unique api key>')
19+
20+
try:
21+
pbin.createAPIUserKey('<username>','<password>')
22+
print pbin.createPasteFromFile('/home/six519/Downloads/email.html', 'Email format testing 2...', FORMAT_HTML, PASTE_PUBLIC, EXPIRE_10_MIN)
23+
except PastebinBadRequestException as e:
24+
print e
25+
except PastebinFileException as e:
26+
print e
27+
28+
Code Documentation
29+
==================
30+
31+
You can read the documentation at: http://pythonhosted.org/pastebin_python/
32+
File renamed without changes.

doc/_build/doctrees/code.doctree

448 KB
Binary file not shown.
49.8 KB
Binary file not shown.

doc/_build/doctrees/index.doctree

5.24 KB
Binary file not shown.

doc/_build/doctrees/intro.doctree

7.89 KB
Binary file not shown.

doc/_build/html/_sources/code.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Code Documentation
2+
******************
3+
4+
.. automodule:: pastebin_python
5+
6+
pastebin
7+
========================
8+
9+
.. automodule:: pastebin_python.pastebin
10+
11+
.. autoclass:: pastebin_python.pastebin.PastebinPython
12+
:special-members:
13+
:private-members:
14+
:members:
15+
16+
pastebin_exceptions
17+
===================
18+
19+
.. automodule:: pastebin_python.pastebin_exceptions
20+
:undoc-members:
21+
:members:
22+
23+
pastebin_constants
24+
==================
25+
26+
.. automodule:: pastebin_python.pastebin_constants
27+
:members:
28+
29+
pastebin_formats
30+
================
31+
32+
.. automodule:: pastebin_python.pastebin_formats
33+
:members:
34+
35+
pastebin_options
36+
================
37+
38+
.. automodule:: pastebin_python.pastebin_options
39+
:members:
40+

pastebin_python/doc/_build/html/_sources/index.txt renamed to doc/_build/html/_sources/index.txt

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,17 @@
44
contain the root `toctree` directive.
55

66
Welcome to pastebin_python's documentation!
7-
===========================================
7+
*******************************************
88

99
.. toctree::
10-
:titlesonly:
10+
:maxdepth: 1
1111

12-
pastebin
13-
pastebin_constants
14-
pastebin_exceptions
15-
pastebin_formats
16-
pastebin_options
12+
intro
13+
code
1714

1815
Indices and tables
19-
==================
16+
******************
2017

2118
* :ref:`genindex`
2219
* :ref:`modindex`
2320
* :ref:`search`
24-

doc/_build/html/_sources/intro.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
PastebinPython
2+
**************
3+
4+
A complete pastebin.com API wrapper for Python
5+
6+
PastebinPython source code URL
7+
==============================
8+
9+
https://github.com/six519/PastebinPython
10+
11+
Cloning the source code
12+
=======================
13+
14+
::
15+
16+
$ git clone https://github.com/six519/PastebinPython.git
17+
18+
Steps to get PastebinPython running
19+
=======================================
20+
21+
* Create an account to http://pastebin.com/signup
22+
* After logging in, you can get your unique developer API key to http://pastebin.com/api
23+
* Install the *PastebinPython* module by executing either one of the command
24+
25+
#. ``easy_install pastebin_python``
26+
#. ``pip install pastebin_python``
27+
28+
* You can verify if the installation is successfull by running this command with no errors in Python interactive shell::
29+
30+
>>> import pastebin_python
31+
>>> pastebin_python.__version__
32+
'1.1'

doc/_build/html/code.html

Lines changed: 1637 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)