https://github.com/olist/correios

A client library for Brazilian Correios APIs and services (SIGEP & SRO).
https://github.com/olist/correios

apache brazil client correios freight python python-3 sigep sro

Last synced: 3 months ago
JSON representation

A client library for Brazilian Correios APIs and services (SIGEP & SRO).

• Host: GitHub
• URL: https://github.com/olist/correios
• Owner: olist
• License: apache-2.0
• Created: 2016-05-20T02:25:59.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T21:51:24.000Z (almost 2 years ago)
• Last Synced: 2024-09-17T07:57:58.429Z (4 months ago)
• Topics: apache, brazil, client, correios, freight, python, python-3, sigep, sro
• Language: Python
• Homepage:
• Size: 20.9 MB
• Stars: 171
• Watchers: 116
• Forks: 44
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - correios - A client library for Brazilian Correios APIs and services (SIGEP & SRO). (Python)

README

        
correios

========

.. image:: https://img.shields.io/pypi/v/correios.svg

    :target: https://pypi.python.org/pypi/correios

    :alt: Latest PyPI version

.. image:: https://travis-ci.org/olist/correios.png

   :target: https://travis-ci.org/olist/correios

   :alt: Latest Travis CI build status

.. image:: https://codecov.io/gh/olist/correios/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/olist/correios

   :alt: Latest coverage status

.. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Folist%2Fcorreios.svg?type=shield

    :target: https://app.fossa.com/projects/git%2Bgithub.com%2Folist%2Fcorreios?ref=badge_shield

    :alt: FOSSA Status

A client library for Brazilian Correios APIs (SIGEP and SRO) and services.

Installation

------------

.. code-block::

   $ pip install correios  # basic model support

   $ pip install correios[pdf]  # label and posting list pdf generation support

   $ pip install correios[api]  # support for SIGEP/SRO API client

   $ pip install correios[pdf,api]  # full installation

Update Local WSDL Files

-----------------------

Local WSDL files are used to increase performance on SOAP requests. Enventually

you'll want to update them without having to update this lib.

If you want to maintain this files on a custom path you can pass the 'path'

option with the custom path. Don't use relative paths.

Just run on shell

.. code-block::

   $ update-correios-wsdl -p /path/to/your/custom/wsdl/folder

Arguments:

-p, --path : Custom path where wsdl files will be saved, note that this option

will have higher priority than the value of the envvar 'CORREIOS_WSDL_PATH'

Or you can use the method update_wsdl to do it.

.. code-block::

   from correios.update_wsdl import update_wsdl

   update_wsdl(path='/path/to/your/custom/wsdl/folder')

Contributing

------------

Fork this repository, make changes and send us a pull request. We will review

your changes and apply them. Before sending us your pull request please check

if you wrote and ran tests:

.. code-block::

    $ make test

Also, remember to update the WSDL files:

.. code-block::

    $ make update-wsdl