Skip to content

Commit 9d2c792

Browse files
committed
updating docs and __init__.py
1 parent c76cb3e commit 9d2c792

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To start using the library, first import the ``XBRLParser``
4343

4444
::
4545

46-
from xbrl import XBRLParser
46+
from xbrl import XBRLParser, GAAP, GAAPSerializer
4747

4848
Simple Parsing Workflow
4949
-----------------------
@@ -53,13 +53,13 @@ First parse the incoming XRBL file into a new ``XBRL`` basic object
5353
::
5454

5555
xbrl_parser = XBRLParser()
56-
xbrl = XBRLParser.parse(file("sam-20131228.xml"))
56+
xbrl = xbrl_parser.parse(file("sam-20131228.xml"))
5757

5858
Then you can parse the document using different parsers
5959

6060
::
6161

62-
gaap_obj = XBRLParser.parseGAAP(xbrl, doc_date="20131228", doc_type="10-K", context="current", ignore_errors=0)
62+
gaap_obj = xbrl_parser.parseGAAP(xbrl, doc_date="20131228", doc_type="10-K", context="current", ignore_errors=0)
6363

6464
Now we have a ``GAAP`` model object that has the GAAP parsed elements
6565
from the document.

examples/gaap.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
xbrl_parser = XBRLParser(precision=0)
77

88
# Parse an incoming XBRL file
9-
xbrl = xbrl_parser.parse(file("../tests/sam-20130629.xml"))
9+
xbrl = xbrl_parser.parseGAAP(file("../tests/sam-20130629.xml"))
1010

1111
# Parse just the GAAP data from the xbrl object
1212
gaap_obj = xbrl_parser.parseGAAP(xbrl,

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010

1111
setup(
1212
name='python-xbrl',
13-
version='1.0.9',
13+
version='1.1.0',
1414
description='library for parsing xbrl documents',
1515
author='Joe Cabrera',
1616
author_email='[email protected]',
1717
url='https://github.com/greedo/python-xbrl/',
1818
license='Apache License',
1919
keywords='xbrl, Financial, Accounting, file formats',
20-
packages=find_packages(exclude=['tests*']),
20+
packages=['xbrl'],
2121
install_requires=['pytest', 'pep8', 'marshmallow',
2222
'beautifulsoup4', 'ordereddict', 'lxml', 'six'],
2323
classifiers=[

xbrl/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
from __future__ import absolute_import
55

6-
version = (1, 0, 9)
6+
version = (1, 1, 0)
77

88
from .xbrl import XBRLParser, GAAP, GAAPSerializer, XBRLParserException

0 commit comments

Comments
 (0)