Welcome to taxydromikilib’s documentation!

Contents:

taxydromikilib

A small library to search taxydromiki for parsels and their status

Features

  • TODO

Installation

At the command line:

$ pip install taxydromikilib

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv taxydromikilib
$ pip install taxydromikilib

Usage

To use taxydromikilib in a project:

from taxydromikilib import Taxydromiki
taxydromiki = Taxydromiki()
states = server.search(VALID_PACKAGE_NUMBER)

for state in states:
    if state.is_final:
        print('This state concludes the delivery of the packet')
    print(state.status)
    print(state.location)
    print(state.date)
    print(state.time)

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Get Started!

Ready to contribute? Here’s how to set up taxydromikilib for local development.

  1. Clone your fork locally:

    $ git clone https://github.com/costastf/taxydromikilib.git
    
  2. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your clone for local development:

    $ mkvirtualenv taxydromikilib
    $ cd taxydromikilib/
    $ python setup.py develop
    
  3. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

    Now you can make your changes locally.

  4. Commit your changes and push your branch to the server:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  5. Submit a merge request

taxydromikilib

taxydromikilib package

Submodules

taxydromikilib.taxydromikilib module

Main module file

Put your classes here

class taxydromikilib.taxydromikilib.Taxydromiki[source]

Bases: object

search(tracking_number)[source]
class taxydromikilib.taxydromikilib.TrackingState(data)[source]

Bases: object

date
is_final
location
status
time

taxydromikilib.taxydromikilibexceptions module

Main module Exceptions file

Put your exception classes here

Module contents

taxydromikilib package

Imports all parts from taxydromikilib here

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1 (25-09-2017)

  • First release

Indices and tables

ref:search