Revert "test_superfaktura_api: add type ignore for pytest"

This reverts commit d0147a0451.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/deploy-docs.yml

@@ -0,0 +1,33 @@
+name: Deploy Sphinx Documentation
+
+on: [push]
+permissions:
+  contents: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx-rtd-theme
+          pip install -e .
+
+      - name: Build documentation
+        run: |
+          make -C docs html
+          touch docs/build/html/.nojekyll
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/build/html

.github/workflows/mypy.yml

@@ -0,0 +1,24 @@
+name: MyPy Type Checking
+
+on: [push]
+
+jobs:
+  type-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_dev.txt
+
+      - name: Run MyPy
+        run: mypy .

.github/workflows/pylint.yml

@@ -0,0 +1,48 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: pylint
+      run: |
+        pylint $(git ls-files '*.py' | grep -v '^test/') --fail-under=9.0 --output-format=json > pylint-report.json
+
+    - name: Generate Pylint Score
+      id: pylint_score
+      run: |
+        SCORE=$(cat pylint-report.json | jq '[.[].score] | add / length' || echo 0)
+        echo "score=${SCORE:-0}" >> $GITHUB_ENV
+
+    - name: Upload Pylint Report
+      uses: actions/upload-artifact@v4
+      with:
+        name: pylint-report
+        path: pylint-report.json
+
+    - name: Create Pylint Badge
+      run: |
+        SCORE=$(echo "${{ env.score }}" | awk '{print int($1)}')
+        COLOR="red"
+        if [ "$SCORE" -ge 8 ]; then COLOR="green"; elif [ "$SCORE" -ge 5 ]; then COLOR="yellow"; fi
+        curl -o pylint-badge.svg "https://img.shields.io/badge/Pylint-$SCORE%2F10-$COLOR"
+
+    - name: Upload Pylint Badge
+      uses: actions/upload-artifact@v4
+      with:
+        name: pylint-badge
+        path: pylint-badge.svg

.github/workflows/pytest.yml

@@ -0,0 +1,29 @@
+name: PyTest
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements_dev.txt
+    - name: Test with pytest
+      run: |
+        mkdir -p junit
+        pytest test/ --doctest-modules --junitxml=junit/test-results.xml --cov=superfaktura --cov-report=xml --cov-report=html
+    - name: Upload pytest test results
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-results
+        path: junit/test-results.xml
+      # Use always() to always run this step to publish test results when there are test failures
+      if: ${{ always() }}

.github/workflows/python-package.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

LICENSE

@@ -1,674 +1,21 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+MIT License
+
+Copyright (c) 2025 Eledio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,9 @@
 # SuperFaktura API client
 
+![Pylint Score](https://github.com/eledio-helpers/superfaktura-client/actions/workflows/pylint.yml/badge.svg)
+
+[Online documentation](https://eledio.github.io/superfaktura-client)
+
 Library for handling of SuperFaktura API.
 
 Environment variables:

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,35 @@
+# type: ignore
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "SuperFaktura API client"
+copyright = "2025, Richard Kubíček, Eledio s.r.o."
+author = "Richard Kubíček"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

docs/source/examples.rst

@@ -0,0 +1,19 @@
+Examples of SuperFaktura API client usage
+====================
+
+
+Add Invoice
+---------------------------------
+
+.. automodule:: examples.add_invoice
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Get country list
+------------------------------------
+
+.. automodule:: examples.get_country_list
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/index.rst

@@ -0,0 +1,9 @@
+Welcome to SuperFaktura Client's documentation
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+
+   superfaktura
+   installation
+   examples

docs/source/installation.rst

@@ -0,0 +1,7 @@
+Installation
+====================
+
+To install SuperFaktura Client, run the following command::
+
+    pip install git+https://github.com/Eledio/superfaktura-client
+

docs/source/superfaktura.bank_account.rst

@@ -0,0 +1,7 @@
+superfaktura.bank\_account module
+=================================
+
+.. automodule:: superfaktura.bank_account
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.client_contacts.rst

@@ -0,0 +1,7 @@
+superfaktura.client\_contacts module
+====================================
+
+.. automodule:: superfaktura.client_contacts
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.enumerations.currency.rst

@@ -0,0 +1,7 @@
+superfaktura.enumerations.currency module
+=========================================
+
+.. automodule:: superfaktura.enumerations.currency
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.enumerations.rst

@@ -0,0 +1,21 @@
+superfaktura.enumerations package
+=================================
+
+Submodules
+----------
+
+superfaktura.enumerations.currency module
+-----------------------------------------
+
+.. automodule:: superfaktura.enumerations.currency
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: superfaktura.enumerations
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.invoice.rst

@@ -0,0 +1,7 @@
+superfaktura.invoice module
+===========================
+
+.. automodule:: superfaktura.invoice
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.rst

@@ -0,0 +1,35 @@
+SuperFaktura API client
+====================
+
+
+Bank account
+---------------------------------
+
+.. automodule:: superfaktura.bank_account
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Client contacts
+------------------------------------
+
+.. automodule:: superfaktura.client_contacts
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Invoice
+---------------------------
+
+.. automodule:: superfaktura.invoice
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SuperFaktura API
+-------------------------------------
+
+.. automodule:: superfaktura.superfaktura_api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.superfaktura_api.rst

@@ -0,0 +1,7 @@
+superfaktura.superfaktura\_api module
+=====================================
+
+.. automodule:: superfaktura.superfaktura_api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.utils.country.rst

@@ -0,0 +1,7 @@
+superfaktura.utils.country module
+=================================
+
+.. automodule:: superfaktura.utils.country
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.utils.data_types.rst

@@ -0,0 +1,7 @@
+superfaktura.utils.data\_types module
+=====================================
+
+.. automodule:: superfaktura.utils.data_types
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/superfaktura.utils.rst

@@ -0,0 +1,29 @@
+superfaktura.utils package
+==========================
+
+Submodules
+----------
+
+superfaktura.utils.country module
+---------------------------------
+
+.. automodule:: superfaktura.utils.country
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+superfaktura.utils.data\_types module
+-------------------------------------
+
+.. automodule:: superfaktura.utils.data_types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: superfaktura.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

examples/add_invoice.py

@@ -0,0 +1,87 @@
+"""
+Main script to add an invoice and save it as a PDF using the SuperFaktura API.
+
+This script demonstrates how to create an invoice with multiple items,
+retrieve the invoice as a PDF, and save the PDF to a file.
+
+Usage:
+    Run this script directly to create and save an invoice PDF.
+
+Dependencies:
+    - superfaktura.bank_account.BankAccount
+    - superfaktura.client_contacts.ClientContactModel
+    - superfaktura.enumerations.currency.Currencies
+    - superfaktura.enumerations.language.Language
+    - superfaktura.invoice.Invoice
+    - superfaktura.invoice.InvoiceModel
+    - superfaktura.invoice.InvoiceType
+    - superfaktura.invoice.InvoiceItem
+    - superfaktura.invoice.InvoiceSettings
+    - superfaktura.utils.data_types.Date
+"""
+
+from superfaktura.bank_account import BankAccount, NoDefaultBankAccountException
+from superfaktura.client_contacts import ClientContactModel
+from superfaktura.enumerations.currency import Currencies
+from superfaktura.enumerations.language import Language
+from superfaktura.invoice import (
+    Invoice,
+    InvoiceModel,
+    InvoiceType,
+    InvoiceItem,
+    InvoiceSettings,
+)
+from superfaktura.utils.data_types import Date
+
+
+def main():
+    """
+    Main function to add Invoice and save it as a pdf using the SuperFaktura API.
+    """
+    invoice = Invoice()
+    bank = BankAccount()
+    try:
+        # Get default bank account
+        bank_account = bank.default().as_dict()
+    except NoDefaultBankAccountException as e:
+        print(f"Error getting default bank account: {e}")
+        bank_account = {}
+    resp = invoice.add(
+        invoice_model=InvoiceModel(
+            type=InvoiceType.INVOICE,
+            name="My First Invoice",
+            due=Date("2025-04-01"),
+            invoice_currency=Currencies.EUR,
+            header_comment="We invoice you for services",
+            bank_accounts=[bank_account],
+        ),
+        items=[
+            InvoiceItem(
+                name="Website Development", unit_price=1000.0, quantity=1, tax=20
+            ),
+            InvoiceItem(
+                name="Hosting Service (1 year)", unit_price=500.0, quantity=1, tax=20
+            ),
+        ],
+        contact=ClientContactModel(
+            name="John Doe",
+            email="john.doe@examle.com",
+            phone="+1 555-1234",
+            address="123 Main Street, New York",
+            ico="987654321",
+            update=True,
+            country_id=225,
+        ),
+        invoice_settings=InvoiceSettings(language=Language.English),
+    )
+
+    try:
+        with open("invoice.pdf", "wb") as f:
+            invoice.get_pdf(invoice=resp, descriptor=f, language=Language.English)
+        print("Invoice saved to 'invoice.pdf'")
+    except Exception as e:
+        print(f"Error generating or saving invoice as PDF: {e}")
+
+
+if __name__ == "__main__":
+    main()

examples/get_country_list.py

@@ -0,0 +1,18 @@
+"""
+This script retrieves and prints the list of countries using the SuperFaktura API.
+"""
+
+from pprint import pprint
+
+from superfaktura.utils.country import country_list
+
+
+def main():
+    """
+    Main function to retrieve and print the list of countries using the SuperFaktura API.
+    """
+    pprint(country_list())
+
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -1,2 +1,3 @@
 requests~=2.32.3
-python-dotenv~=1.0.1
+python-dotenv~=1.0.1
+setuptools~=75.8.0

requirements_dev.txt

@@ -0,0 +1,7 @@
+requests~=2.32.3
+python-dotenv~=1.0.1
+pytest~=8.3.5
+pytest-cov~=6.0.0
+mypy~=1.9.0
+types-requests~=2.31
+types-setuptools~=68.2

ruff.toml

@@ -0,0 +1,5 @@
+[lint]
+ignore = [
+    # Use a single `if` statement instead of nested `if` statements
+    "SIM102",
+]

setup.py

@@ -1,15 +1,12 @@
 from setuptools import setup, find_namespace_packages
 
 setup(
-    name='superfaktura_client',
-    version='0.1.0',
+    name="superfaktura_client",
+    version="1.0.0",
     packages=find_namespace_packages(),
-    url='https://github.com/eledio-helpers/superfaktura-client',
-    license='GNU GPLv3',
-    author='Richard Kubíček',
-    author_email='kubicekr@eledio.com',
-    install_requires=[
-        "requests",
-        "python-dotenv"
-    ],
+    url="https://github.com/eledio-helpers/superfaktura-client",
+    license="MIT",
+    author="Richard Kubíček",
+    author_email="kubicekr@eledio.com",
+    install_requires=["requests", "python-dotenv"],
 )

superfaktura/bank_account.py

@@ -1,3 +1,32 @@
+"""
+Bank Account Module.
+
+This module provides classes and functions for working with bank accounts in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting bank accounts.
+
+Classes:
+    - BankAccountModel: Dataclass representing a bank account.
+    - BankAccount: Class for interacting with bank accounts.
+
+Exceptions:
+    - NoDefaultBankAccountException: Exception for when no default bank account is found.
+
+Functions:
+    - (none)
+
+Usage:
+    >>> import superfaktura.bank_account
+    >>> # Create an instance of BankAccount
+    >>> bank = superfaktura.bank_account.BankAccount()
+    >>> # Retrieve a list of bank accounts
+    >>> accounts = bank.list()
+    >>> # Get the default bank account
+    >>> default_account = bank.default()
+    >>> # Create or update a bank account
+    >>> data = {"account": "1234567890", "bank_code": "1234567890", "default": True}
+    >>> bank.post(data)
+"""
+
 from dataclasses import dataclass, asdict
 from typing import Optional
 
@@ -5,11 +34,13 @@ from superfaktura.superfaktura_api import SuperFakturaAPI
 
 
 class NoDefaultBankAccountException(Exception):
-    pass
+    """Exception for when no default bank account is found."""
 
 
 @dataclass
 class BankAccountModel:
+    """Dataclass representing a bank account."""
+
     account: Optional[str]
     bank_code: Optional[str]
     bank_name: Optional[str]
@@ -20,6 +51,7 @@ class BankAccountModel:
     id: Optional[int]
 
     def as_dict(self) -> dict:
+        """Returns a dictionary representation of the BankAccountModel."""
         data = asdict(self)
         for key in list(data.keys()):
             if data[key] is None:
@@ -28,24 +60,42 @@ class BankAccountModel:
 
     @staticmethod
     def from_dict(data: dict) -> "BankAccountModel":
+        """Creates a BankAccountModel from a dictionary."""
         return BankAccountModel(
-            **{
-                k: v
-                for k, v in data.items()
-                if k in BankAccountModel.__dataclass_fields__
-            }
+            **{k: v for k, v in data.items() if k in BankAccountModel.__annotations__}
         )
 
 
 class BankAccount(SuperFakturaAPI):
+    """
+    Bank Account Class.
+
+    This class provides methods for interacting with bank accounts in the SuperFaktura API.
+    It allows for retrieving, creating, updating, and deleting bank accounts.
+
+    Methods:
+        - list: Retrieves a list of bank accounts.
+        - default: Retrieves the default bank account.
+        - post: Creates or updates a bank account.
+
+    Usage:
+        >>> bank = BankAccount()
+        >>> accounts = bank.list()
+        >>> default_account = bank.default()
+        >>> data = {"account": "1234567890", "bank_code": "1234567890", "default": True}
+        >>> bank.post(data)
+    """
+
     def __init__(self):
         super().__init__()
 
     def list(self) -> dict:
+        """Retrieves a list of bank accounts."""
         url = "bank_accounts/index"
         return self.get(url)
 
     def default(self) -> Optional[BankAccountModel]:
+        """Retrieves the default bank account."""
         accounts = self.list()["BankAccounts"]
         for account in accounts:
             if account["BankAccount"]["default"]:

superfaktura/client_contacts.py

@@ -1,3 +1,24 @@
+"""
+Module for interacting with client contacts in SuperFaktura.
+
+This module provides classes and functions for working with client contacts,
+including creating, reading, and updating contact information.
+
+Classes:
+    ClientException: Base class for client exceptions.
+    ClientContactModel: Dataclass representing a client contact.
+
+Functions:
+    (none)
+
+Variables:
+    (none)
+
+Notes:
+    This module uses the SuperFaktura API to interact with client contacts.
+    You must have a valid API key and credentials to use this module.
+"""
+
 import dataclasses
 import json
 from pprint import pprint
@@ -7,11 +28,13 @@ from superfaktura.superfaktura_api import SuperFakturaAPI
 
 
 class ClientException(Exception):
-    pass
+    """Base class for client exceptions."""
 
 
 @dataclasses.dataclass
 class ClientContactModel:
+    """Client contact model."""
+
     name: str
     address: Optional[str] = None
     bank_account: Optional[str] = None
@@ -48,6 +71,7 @@ class ClientContactModel:
     id: Optional[int] = None
 
     def as_dict(self) -> dict:
+        """Returns a dictionary representation of the ClientContactModel."""
         data = dataclasses.asdict(self)
         for key in list(data.keys()):
             if data[key] is None:
@@ -56,32 +80,34 @@ class ClientContactModel:
 
     @staticmethod
     def from_dict(data: dict) -> "ClientContactModel":
+        """Creates a ClientContactModel from a dictionary."""
         return ClientContactModel(
-            **{
-                k: v
-                for k, v in data.items()
-                if k in ClientContactModel.__dataclass_fields__
-            }
+            **{k: v for k, v in data.items() if k in ClientContactModel.__annotations__}
         )
 
 
 class ClientContact(SuperFakturaAPI):
+    """Client contact class."""
+
     def __init__(self):
         super().__init__()
 
     def add_contact(self, contact: ClientContactModel) -> bool:
+        """Adds a new client contact."""
         url = "clients/create"
         data = {"Client": contact.as_dict()}
-        resp = self.post(endpoint=url, data=json.dumps(data))
-        if resp["error_message"] == "Client created":
+        response = self.post(endpoint=url, data=json.dumps(data))
+        if response["error_message"] == "Client created":
             return True
         return False
 
     def list(self) -> dict:
+        """Lists all exists client contacts."""
         url = "clients/index.json"
         return self.get(endpoint=url)
 
     def get_client(self, client_id: int) -> ClientContactModel:
+        """Gets a client contact by ID."""
         url = f"clients/view/{client_id}"
         data = self.get(endpoint=url)
         if "Client" not in data:

superfaktura/enumerations/currency.py

@@ -1,3 +1,30 @@
+"""
+Currency Enumeration.
+
+This module provides an enumeration of currencies that can be used in the SuperFaktura API.
+
+Classes:
+    - Currencies: Enumeration of currencies.
+
+Usage:
+    from superfaktura.enumerations.currency import Currencies
+    currency = Currencies.CZK
+"""
+
+
 class Currencies:
+    """
+    Currency Enumeration.
+
+    This enumeration represents the different currencies that can be used in the SuperFaktura API.
+
+    Values:
+        - CZK: Czech Koruna
+        - EUR: Euro
+
+    Usage:
+        currency = Currencies.CZK
+    """
+
     CZK = "CZK"
     EUR = "EUR"

superfaktura/enumerations/language.py

@@ -0,0 +1,54 @@
+"""
+Language Enumeration.
+
+This module provides an enumeration of languages that can be used in the SuperFaktura API.
+
+Classes:
+    - Language: Enumeration of languages.
+
+Usage:
+    from superfaktura.enumerations.language import Language
+    language = Language.Czech
+"""
+
+
+class Language:
+    """
+    Language Enumeration.
+
+    This enumeration represents the different languages that can be used in the SuperFaktura API.
+
+    Values:
+        - Czech: Czech
+        - German: German
+        - English: English
+        - Croatian: Croatian
+        - Hungarian: Hungarian
+        - Italian: Italian
+        - Dutch: Dutch
+        - Polish: Polish
+        - Romanian: Romanian
+        - Russian: Russian
+        - Slovak: Slovak
+        - Slovene: Slovene
+        - Spanish: Spanish
+        - Ukrainian: Ukrainian
+
+    Usage:
+        language = Language.Czech
+    """
+
+    Czech = "cze"
+    German = "deu"
+    English = "eng"
+    Croatian = "hrv"
+    Hungarian = "hun"
+    Italian = "ita"
+    Dutch = "nld"
+    Polish = "pol"
+    Romanian = "rom"
+    Russian = "rus"
+    Slovak = "slo"
+    Slovene = "slv"
+    Spanish = "spa"
+    Ukrainian = "ukr"

superfaktura/invoice.py

@@ -1,16 +1,68 @@
+"""
+Invoice Module.
+
+This module provides classes and functions for working with invoices in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting invoices.
+
+Classes:
+    - InvoiceModel: Dataclass representing an invoice.
+    - InvoiceItem: Dataclass representing an invoice item.
+    - Invoice: Class for interacting with invoices.
+
+Exceptions:
+    - NoDefaultBankAccountException: Exception for when no default bank account is found.
+
+Functions:
+    - (none)
+
+Usage:
+    >>> import superfaktura.invoice
+    >>> # Create an instance of Invoice
+    >>> invoice = superfaktura.invoice.Invoice()
+    >>> # Create an invoice
+    >>> invoice.add(
+        invoice_model=InvoiceModel(
+            type=InvoiceType.INVOICE,
+            name="My First Invoice",
+            due=Date("2025-04-01"),
+            invoice_currency=Currencies.EUR,
+            header_comment="We invoice you for services",
+            bank_accounts=[bank.default().as_dict()],
+        ),
+        items=[
+            InvoiceItem(
+                name="Website Development", unit_price=1000.0, quantity=1, tax=20
+            ),
+            InvoiceItem(
+                name="Hosting Service (1 year)", unit_price=500.0, quantity=1, tax=20
+            ),
+        ],
+        contact=ClientContactModel(
+            name="John Doe",
+            email="john.doe@examle.com",
+            phone="+1 555-1234",
+            address="123 Main Street, New York",
+            ico="987654321",
+            update=True,
+            country_id=225,
+        ),
+    )
+"""
+
 from dataclasses import dataclass, asdict
-from typing import Optional, List
+from typing import Optional, List, IO
 import json
 
-from superfaktura.bank_account import BankAccount
 from superfaktura.client_contacts import ClientContactModel
-from superfaktura.enumerations.currency import Currencies
+from superfaktura.enumerations.language import Language
 from superfaktura.superfaktura_api import SuperFakturaAPI
 from superfaktura.utils.data_types import Date, DateEncoder
 
 
 @dataclass
 class InvoiceModel:
+    """This dataclass represents an invoice in the SuperFaktura API."""
+
     add_rounding_item: Optional[int] = 0
     already_paid: Optional[int] = None
     bank_accounts: Optional[List[dict]] = None
@@ -51,6 +103,7 @@ class InvoiceModel:
     vat_transfer: Optional[int] = None
 
     def as_dict(self) -> dict:
+        """Returns a dictionary representation of the InvoiceModel."""
         data = asdict(self)
         for key in list(data.keys()):
             if data[key] is None:
@@ -66,6 +119,8 @@ class InvoiceModel:
 
 @dataclass
 class InvoiceItem:
+    """This dataclass represents an invoice item in the SuperFaktura API."""
+
     name: str
     unit_price: float
     description: Optional[str] = None
@@ -80,6 +135,50 @@ class InvoiceItem:
     use_document_currency: Optional[int] = 0
 
     def as_dict(self) -> dict:
+        """Returns a dictionary representation of the InvoiceItem."""
+        data = asdict(self)
+        for key in list(data.keys()):
+            if data[key] is None:
+                del data[key]
+        return data
+
+
+@dataclass
+class InvoiceRespModel:
+    """
+    This dataclass represents the response model for an invoice in the SuperFaktura API.
+
+    Attributes:
+        - error (int): The error code.
+        - error_message (str): The error message.
+        - invoice_id (Optional[int]): The ID of the invoice.
+        - invoice_token (Optional[str]): The token of the invoice.
+    """
+
+    error: int
+    error_message: str
+    invoice_id: Optional[int] = None
+    invoice_token: Optional[str] = None
+
+
+@dataclass
+class InvoiceSettings:
+    """
+    This dataclass represents the settings for an invoice in the SuperFaktura API.
+    """
+
+    language: Optional[str] = None
+    bysquare: Optional[bool] = None
+    callback_payment: Optional[str] = None
+    online_payment: Optional[bool] = None
+    payment_info: Optional[bool] = None
+    paypal: Optional[bool] = None
+    show_prices: Optional[bool] = None
+    signature: Optional[bool] = None
+    summary_bg_color: Optional[str] = None
+
+    def as_dict(self) -> dict:
+        """Returns a dictionary representation of the InvoiceSettings."""
         data = asdict(self)
         for key in list(data.keys()):
             if data[key] is None:
@@ -88,56 +187,118 @@ class InvoiceItem:
 
 
 class InvoiceType:
+    """
+    Invoice Type Enumeration.
+
+    This enumeration represents the different types of invoices that can be created.
+
+    Usage:
+        invoice_type = InvoiceType.PROFORMA
+    """
+
     PROFORMA = "proforma"
     INVOICE = "regular"
 
 
 class Invoice(SuperFakturaAPI):
+    """
+    Invoice Class.
+
+    This class provides methods for interacting with invoices in the SuperFaktura API.
+    It allows for retrieving, creating, updating, and deleting invoices.
+
+    Methods:
+        - add: Creates a new invoice.
+        - get: Retrieves an invoice by ID.
+        - list: Retrieves a list of invoices.
+        - update: Updates an existing invoice.
+
+    Usage:
+        >>> invoice = Invoice()
+        >>> invoice.add(
+            invoice_model=InvoiceModel(
+                type=InvoiceType.INVOICE,
+                name="My First Invoice",
+                due=Date("2025-04-01"),
+                invoice_currency=Currencies.EUR,
+                header_comment="We invoice you for services",
+                bank_accounts=[bank.default().as_dict()],
+            ),
+            items=[
+                InvoiceItem(
+                    name="Website Development", unit_price=1000.0, quantity=1, tax=20
+                ),
+                InvoiceItem(
+                    name="Hosting Service (1 year)", unit_price=500.0, quantity=1, tax=20
+                ),
+            ],
+            contact=ClientContactModel(
+                name="John Doe",
+                email="john.doe@example.com",
+                phone="+1 555-1234",
+                address="123 Main Street, New York",
+                ico="987654321",
+                update=True,
+                country_id=225,
+            ),
+        )
+    """
+
     def __init__(self):
         super().__init__()
 
     def add(
         self,
-        invoice: InvoiceModel,
+        invoice_model: InvoiceModel,
         items: List[InvoiceItem],
         contact: ClientContactModel,
-    ):
+        invoice_settings: Optional[InvoiceSettings] = None,
+    ) -> InvoiceRespModel:
+        """
+        Adds a new invoice.
+
+        Args:
+            invoice_model (InvoiceModel): The invoice model.
+            items (List[InvoiceItem]): List of invoice items.
+            contact (ClientContactModel): The client contact model.
+            invoice_settings (Optional[InvoiceSettings]): The invoice settings.
+
+        Returns:
+            InvoiceRespModel: The response model for the invoice.
+        """
         data = {
-            "Invoice": invoice.as_dict(),
+            "Invoice": invoice_model.as_dict(),
             "InvoiceItem": [item.as_dict() for item in items],
             "Client": contact.as_dict(),
+            "InvoiceSetting": invoice_settings.as_dict() if invoice_settings else {},
         }
         url = "invoices/create"
         resp = self.post(endpoint=url, data=json.dumps(data, cls=DateEncoder))
-        return resp
+        invoice_resp = InvoiceRespModel(
+            error=resp["error"], error_message=resp["error_message"]
+        )
+        if "data" in resp:
+            if "Invoice" in resp["data"]:
+                invoice_resp.invoice_id = int(resp["data"]["Invoice"]["id"])
+                invoice_resp.invoice_token = resp["data"]["Invoice"]["token"]
+        return invoice_resp
 
+    def get_pdf(
+        self,
+        invoice: InvoiceRespModel,
+        descriptor: IO[bytes],
+        language: str = Language.Czech,
+    ) -> None:
+        """
+        Retrieves the PDF of the invoice.
 
-if __name__ == "__main__":
-    invoice = Invoice()
-    bank = BankAccount()
-    invoice.add(
-        invoice=InvoiceModel(
-            type=InvoiceType.PROFORMA,
-            name="Invoice 3",
-            due=Date("2025-02-01"),
-            invoice_currency=Currencies.CZK,
-            header_comment="We invoice you for services",
-            bank_accounts=[bank.default().as_dict()],
-        ),
-        items=[
-            InvoiceItem(name="Services", unit_price=100, quantity=1, unit="ks", tax=21),
-            InvoiceItem(name="SIM card", unit_price=50, quantity=1, tax=21, unit="ks"),
-            InvoiceItem(
-                name="SIM card 2", unit_price=75, quantity=1, tax=21, unit="ks"
-            ),
-        ],
-        contact=ClientContactModel(
-            name="Richard Kubíček",
-            email="kubicekr@eledio.com",
-            phone="+420 123 456 789",
-            address="Jaroslava Foglara 861/1",
-            ico="123",
-            update=True,
-            country_id=57,
-        ),
-    )
+        Args:
+            invoice (InvoiceRespModel): The response model for the invoice.
+            descriptor (IO[bytes]): The descriptor to write the PDF data to.
+            language (str): The language for the PDF.
+
+        Returns:
+            None
+        """
+        url = f"{language}/invoices/pdf/{invoice.invoice_id}/token:{invoice.invoice_token}"
+        self.download(url, descriptor)

superfaktura/superfaktura_api.py

@@ -1,18 +1,46 @@
-from typing import Dict
+"""
+SuperFaktura API Client.
+
+This module provides classes and functions for working with the SuperFaktura API.
+It allows for reading, creating, updating, and deleting data in SuperFaktura.
+
+Classes:
+    - SuperFakturaAPI: The base class for working with the SuperFaktura API.
+    - SuperFakturaAPIException: An exception for errors when working with the SuperFaktura API.
+    - SuperFakturaAPIMissingCredentialsException: An exception for missing login credentials.
+
+Functions:
+    - get: Retrieves data from the SuperFaktura API.
+    - post: Creates or updates data in the SuperFaktura API.
+
+Usage:
+    >>> import superfaktura.superfaktura_api
+    >>> # Create an instance of SuperFakturaAPI
+    >>> api = superfaktura.superfaktura_api.SuperFakturaAPI()
+    >>> # Retrieve data from the SuperFaktura API
+    >>> incoming_data = api.get('endpoint')
+    >>> # Create or update data in the SuperFaktura API
+    >>> api.post('endpoint', outgoing_data)
+"""
+
+import os
+from typing import Dict, IO
 
 import requests
-import os
 from dotenv import load_dotenv  # type: ignore
 
 
 class SuperFakturaAPIException(Exception):
-    pass
+    """Exception for errors when working with the SuperFaktura API."""
+
 
 class SuperFakturaAPIMissingCredentialsException(Exception):
-    pass
+    """Exception for missing login credentials."""
 
 
 class SuperFakturaAPI:
+    """Base class for working with the SuperFaktura API."""
+
     def __init__(self) -> None:
         load_dotenv()
         _api_key = os.getenv("SUPERFAKTURA_API_KEY")
@@ -20,28 +48,130 @@ class SuperFakturaAPI:
         _api_mail = os.getenv("SUPERFAKTURA_API_EMAIL")
         _api_company_id = os.getenv("SUPERFAKTURA_API_COMPANY_ID")
         if not _api_key or not self._api_url or not _api_mail or not _api_company_id:
-            raise SuperFakturaAPIMissingCredentialsException('Please ensure, that necessary credentials are set. Please see README.md')
+            raise SuperFakturaAPIMissingCredentialsException(
+                "Please ensure, that necessary "
+                "credentials are set. Please see"
+                " README.md"
+            )
 
         self._auth_header = {
-            "Authorization": f"SFAPI email={_api_mail}&apikey={_api_key}&company_id={_api_company_id}"
+            "Authorization": f"SFAPI email={_api_mail}&apikey={_api_key}&company_id="
+            f"{_api_company_id}"
         }
 
-    def get(self, endpoint: str) -> Dict:
+    def get(self, endpoint: str, timeout: int = 5) -> Dict:
+        """
+        Retrieves data from the SuperFaktura API.
+
+        Retrieves data from the specified endpoint in the SuperFaktura API.
+
+        Args:
+            endpoint (str): The API endpoint to retrieve data from (e.g. 'invoices', 'clients',
+                            etc.).
+            timeout (int, optional): The timeout for the API request in seconds. Defaults to 5.
+
+        Returns:
+            Dict: The retrieved data in JSON format.
+
+        Raises:
+            SuperFakturaAPIException: If the API request fails or returns an error.
+
+        Examples:
+            >>> api = SuperFakturaAPI()
+            >>> data = api.get('invoices')
+            >>> print(data)
+
+        Notes:
+            The available endpoints can be found in the SuperFaktura API documentation.
+        """
         url = f"{self._api_url}/{endpoint}"
-        req = requests.get(url=url, headers=self._auth_header)
+        req = requests.get(url=url, headers=self._auth_header, timeout=timeout)
         if req.status_code == 200:
-            return req.json()
+            try:
+                return req.json()
+            except requests.exceptions.JSONDecodeError as e:
+                raise SuperFakturaAPIException(
+                    f"Unable to decode response as JSON; {req.content!r}; {e}"
+                ) from e
+        raise SuperFakturaAPIException(
+            f"Get status code: {req.status_code}; {req.content!r}"
+        )
+
+    def download(self, endpoint: str, descriptor: IO[bytes], timeout: int = 5) -> None:
+        """
+        Download data stream from the SuperFaktura API.
+
+        Download data stream from the specified endpoint in the SuperFaktura API.
+
+        Args:
+            endpoint (str): The API endpoint to retrieve data from (e.g. 'invoices', 'clients',
+                            etc.).
+            descriptor (IO[bytes]): The descriptor to write the data stream to.
+            timeout (int, optional): The timeout for the API request in seconds. Defaults to 5.
+
+        Returns:
+            None
+
+        Raises:
+            SuperFakturaAPIException: If the API request fails or returns an error.
+
+        Examples:
+            >>> api = SuperFakturaAPI()
+            >>> with open("data.pdf", "wb") as f:
+            >>>     api.download("some/endpoint", descriptor=f)
+
+        Notes:
+            The available endpoints can be found in the SuperFaktura API documentation.
+        """
+        url = f"{self._api_url}/{endpoint}"
+        req = requests.get(url=url, headers=self._auth_header, timeout=timeout)
+        if req.status_code == 200:
+            if descriptor.writable():
+                descriptor.write(req.content)
+            else:
+                raise SuperFakturaAPIException(
+                    f"Descriptor {descriptor} is not writable"
+                )
         else:
             raise SuperFakturaAPIException(
-                f"Get status code: {req.status_code}; {req.json()}"
+                f"Download status code: {req.status_code}; {req.content!r}"
             )
 
-    def post(self, endpoint: str, data: str) -> Dict:
+    def post(self, endpoint: str, data: str, timeout: int = 5) -> Dict:
+        """
+        Creates or updates data in the SuperFaktura API.
+
+        Creates or updates data in the specified endpoint in the SuperFaktura API.
+
+        Args:
+            endpoint (str): The API endpoint to create or update data in (e.g. 'invoices',
+                            'clients', etc.).
+            data (str): The data to be created or updated in JSON format.
+            timeout (int, optional): The timeout for the API request in seconds. Defaults
+                                    to 5.
+
+        Returns:
+            Dict: The created or updated data in JSON format.
+
+        Raises:
+            SuperFakturaAPIException: If the API request fails or returns an error.
+
+        Examples:
+            >>> api = SuperFakturaAPI()
+            >>> data = '{"name": "Example Invoice", "amount": 100.0}'
+            >>> response = api.post('invoices', data)
+            >>> print(response)
+
+        Notes:
+            The available endpoints can be found in the SuperFaktura API documentation.
+            The data should be a valid JSON string.
+        """
         url = f"{self._api_url}/{endpoint}"
-        req = requests.post(url=url, headers=self._auth_header, data={"data": data})
+        req = requests.post(
+            url=url, headers=self._auth_header, data={"data": data}, timeout=timeout
+        )
         if req.status_code == 200:
             return req.json()
-        else:
-            raise SuperFakturaAPIException(
-                f"Post status code: {req.status_code}; {req.json()}"
-            )
+        raise SuperFakturaAPIException(
+            f"Post status code: {req.status_code}; {req.json()}"
+        )

superfaktura/utils/country.py

@@ -1,12 +1,33 @@
-from pprint import pprint
+"""
+Country Module.
+
+This module provides utilities for working with countries in the SuperFaktura API.
+
+Functions:
+    - country_list: Retrieves a list of countries.
+
+Usage:
+    from superfaktura.utils.country import country_list
+    countries = country_list()
+    print(countries)
+"""
 
 from superfaktura.superfaktura_api import SuperFakturaAPI
 
 
 def country_list():
+    """
+    Retrieves a list of countries.
+
+    This function returns a list of countries that can be used in the SuperFaktura API.
+
+    Returns:
+        - list: A list of countries.
+
+    Usage:
+        countries = country_list()
+        print(countries)
+    """
     api = SuperFakturaAPI()
     url = "countries"
     return api.get(url)
-
-
-pprint(country_list())

superfaktura/utils/data_types.py

@@ -1,3 +1,22 @@
+"""
+Data Types Module.
+
+This module provides data types and utilities for working with dates and other data types
+in the SuperFaktura API.
+
+Classes:
+    - Date: Represents a date in the format YYYY-MM-DD.
+    - DateTime: Represents a date and time in the format YYYY-MM-DD HH:MM:SS.
+
+Functions:
+    - (none)
+
+Usage:
+    from superfaktura.utils.data_types import Date, DateTime
+    date = Date("2022-01-01")
+    datetime = DateTime("2022-01-01 12:00:00")
+"""
+
 from datetime import datetime
 from typing import Optional
 
@@ -5,6 +24,22 @@ import json
 
 
 class Date:
+    """
+    Date Class.
+
+    This class represents a date in the format YYYY-MM-DD.
+
+    Attributes:
+        - date (str): The date in the format YYYY-MM-DD.
+
+    Methods:
+        - __str__: Returns the date as a string.
+
+    Usage:
+        date = Date("2022-01-01")
+        print(date)  # Output: 2022-01-01
+    """
+
     def __init__(self, date_str: Optional[str] = None):
         """
         Creates a Date instance that supports typing and validation for the format YYYY-MM-DD.
@@ -25,8 +60,10 @@ class Date:
         """
         try:
             return datetime.strptime(date_str, "%Y-%m-%d")
-        except ValueError:
-            raise ValueError(f"Date must be in format YYYY-MM-DD, got: {date_str}")
+        except ValueError as exc:
+            raise ValueError(
+                f"Date must be in format YYYY-MM-DD, got: {date_str}"
+            ) from exc
 
     def __str__(self) -> str:
         """
@@ -56,6 +93,20 @@ class Date:
 
 
 class DateEncoder(json.JSONEncoder):
+    """
+    Date Encoder Class.
+
+    This class is a custom JSON encoder that converts Date objects to strings.
+
+    Methods:
+        - default: Encodes a Date object as a string.
+
+    Usage:
+        encoder = DateEncoder()
+        date = Date("2022-01-01")
+        json_string = json.dumps(date, cls=encoder)
+    """
+
     def default(self, o):
         if isinstance(o, Date):
             return o.to_json()

test/test_superfaktura_api.py

@@ -0,0 +1,88 @@
+import os
+import pytest
+from unittest.mock import patch, mock_open, MagicMock
+
+import requests
+
+from superfaktura.superfaktura_api import (
+    SuperFakturaAPI,
+    SuperFakturaAPIException,
+    SuperFakturaAPIMissingCredentialsException,
+)
+
+@pytest.fixture
+def api():
+    with patch.dict(os.environ, {
+        "SUPERFAKTURA_API_KEY": "test_key",
+        "SUPERFAKTURA_API_URL": "https://api.superfaktura.cz",
+        "SUPERFAKTURA_API_EMAIL": "test_email",
+        "SUPERFAKTURA_API_COMPANY_ID": "test_company_id"
+    }):
+        return SuperFakturaAPI()
+
+def test_missing_credentials():
+    with patch.dict(os.environ, {}, clear=True):
+        with pytest.raises(SuperFakturaAPIMissingCredentialsException):
+            SuperFakturaAPI()
+
+def test_get(api):
+    with patch("requests.get") as mock_get:
+        mock_get.return_value.status_code = 200
+        mock_get.return_value.json.return_value = {"data": "test"}
+        response = api.get("test_endpoint")
+        assert response == {"data": "test"}
+
+def test_get_failure(api):
+    with patch("requests.get") as mock_get:
+        mock_get.return_value.status_code = 404
+        with pytest.raises(SuperFakturaAPIException):
+            api.get("test_endpoint")
+
+def test_download(api):
+    with patch("requests.get") as mock_get:
+        mock_get.return_value.status_code = 200
+        mock_get.return_value.content = b"test_content"
+        with patch("builtins.open", mock_open()) as mock_file:
+            with open("test_file", "wb") as f:
+                api.download("test_endpoint", f)
+            mock_file().write.assert_called_once_with(b"test_content")
+
+def test_download_failure(api):
+    with patch("requests.get") as mock_get:
+        mock_get.return_value.status_code = 404
+        with patch("builtins.open", mock_open()):
+            with open("test_file", "wb") as f:
+                with pytest.raises(SuperFakturaAPIException):
+                    api.download("test_endpoint", f)
+
+def test_post(api):
+    with patch("requests.post") as mock_post:
+        mock_post.return_value.status_code = 200
+        mock_post.return_value.json.return_value = {"data": "test"}
+        response = api.post("test_endpoint", '{"name": "Example"}')
+        assert response == {"data": "test"}
+
+def test_post_failure(api):
+    with patch("requests.post") as mock_post:
+        mock_post.return_value.status_code = 404
+        mock_post.return_value.json.return_value = {"error": "not found"}
+        with pytest.raises(SuperFakturaAPIException):
+            api.post("test_endpoint", '{"name": "Example"}')
+
+def test_get_invalid_json(api):
+    with patch("requests.get") as mock_get:
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.side_effect = requests.exceptions.JSONDecodeError("msg", "doc", 0)
+        mock_get.return_value = mock_response
+        with pytest.raises(SuperFakturaAPIException, match="Unable to decode response as JSON"):
+            api.get("test_endpoint")
+
+def test_download_not_writable_descriptor(api):
+    with patch("requests.get") as mock_get:
+        mock_get.return_value.status_code = 200
+        mock_get.return_value.content = b"test_content"
+        mock_descriptor = MagicMock()
+        mock_descriptor.writable.return_value = False
+        with pytest.raises(SuperFakturaAPIException, match=" is not writable"):
+            api.download("test_endpoint", mock_descriptor)