summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorLeonard Richardson <leonardr@segfault.org>2018-08-12 10:58:24 -0400
committerLeonard Richardson <leonardr@segfault.org>2018-08-12 10:58:24 -0400
commit427a877bc1a02fa95d83ac2500f94cba2e91501f (patch)
treee2d0fa95cc2e6c6e952bf9471eb1dac8f6d3ff5a /README.txt
parent71e6e49af92cc395c1896b845042fced8f6ed6a7 (diff)
Converted README to Markdown format.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt63
1 files changed, 0 insertions, 63 deletions
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 305c51e..0000000
--- a/README.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-= Introduction =
-
- >>> from bs4 import BeautifulSoup
- >>> soup = BeautifulSoup("<p>Some<b>bad<i>HTML")
- >>> print soup.prettify()
- <html>
- <body>
- <p>
- Some
- <b>
- bad
- <i>
- HTML
- </i>
- </b>
- </p>
- </body>
- </html>
- >>> soup.find(text="bad")
- u'bad'
-
- >>> soup.i
- <i>HTML</i>
-
- >>> soup = BeautifulSoup("<tag1>Some<tag2/>bad<tag3>XML", "xml")
- >>> print soup.prettify()
- <?xml version="1.0" encoding="utf-8">
- <tag1>
- Some
- <tag2 />
- bad
- <tag3>
- XML
- </tag3>
- </tag1>
-
-= Full documentation =
-
-The bs4/doc/ directory contains full documentation in Sphinx
-format. Run "make html" in that directory to create HTML
-documentation.
-
-= Running the unit tests =
-
-Beautiful Soup supports unit test discovery from the project root directory:
-
- $ nosetests
-
- $ python -m unittest discover -s bs4 # Python 2.7 and up
-
-If you checked out the source tree, you should see a script in the
-home directory called test-all-versions. This script will run the unit
-tests under Python 2.7, then create a temporary Python 3 conversion of
-the source and run the unit tests again under Python 3.
-
-= Links =
-
-Homepage: http://www.crummy.com/software/BeautifulSoup/bs4/
-Documentation: http://www.crummy.com/software/BeautifulSoup/bs4/doc/
- http://readthedocs.org/docs/beautiful-soup-4/
-Discussion group: http://groups.google.com/group/beautifulsoup/
-Development: https://code.launchpad.net/beautifulsoup/
-Bug tracker: https://bugs.launchpad.net/beautifulsoup/