roulier


Nameroulier JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/akretion/roulier
SummaryLabel parcels without pain
upload_time2021-04-02 08:59:07
maintainer
docs_urlNone
authorHparfr <https://github.com/hparfr>
requires_python
license
keywords carrier logistics delivery
VCS
bugtrack_url
requirements Cerberus jinja2
Travis-CI
coveralls test coverage No coveralls.
            Roulier
===

Roulier is a shipping library written in Python for sending parcels.
Roulier will get a label + tracking number to your carrier for you.


![big picture](overview.svg)


* Roulier runs on your server and call each carrier API directly.
* You have to use your own credentials provided by each carriers.
* Roulier is Open Source software, AGPL-3
* Roulier integrate a multitude of carriers
    * French La Poste
    * French DPD
    * French GLS
    * French Chronopost
    * more to come... (geodis, kuehne...)

### Installation

This is not compatible with python 2.7.
Please use version < 1.0.0 (python2 branch) in that case.

### Usage

```python
from roulier import roulier

payload= {
	"auth": {
		"login": "12345",
		"password": "password",
	},
	"service": {
		"productCode": "COL"
	},
	"parcels": [{
		"weight": 3.4,
	}],
	"to_address": {
		"firstName": "Hparfr"
		"street1": "35 b Rue Montgolfier"
		"city": "Villeurbanne"
        "country": "FR",
        "zip": "69100"
   	},
   	"from_address": {
		"fristName": "Akretion France"
		"street1": "35 b Rue Montgolfier"
		"city": "Villeurbanne"
        "country": "FR",
        "zip": "69100"
   	},
}
# first parameter is the carrier type.
# second is the action and then the parameters needed by the action
response = roulier.get('laposte_fr', 'get_label', payload)


print(response)

```


Get supported carriers and related actions:
```python
from roulier import roulier
print(roulier.get_carriers_action_available())
```

### Known Issues
#### French GLS carrier :
* The glsbox webservice only manage Basic products : BP, EBP, GBP
* In the rest webservice, the incoterms don't work


### Contributors


* [@hparfr](https://github.com/hparfr) ([Akretion.com](https://akretion.com))
* [@damdam-s](https://github.com/damdam-s) ([Camp2Camp.com](http://camptocamp.com))
* [@bealdav](https://github.com/bealdav) ([Akretion.com](https://akretion.com))
* [@DylannCordel](https://github.com/DylannCordel) ([Webu.coop](https://www.webu.coop))
* [@florian-dacosta](https://github.com/florian-dacosta) ([Webu.coop](https://akretion.com))


### Dependencies

* [Cerberus](http://docs.python-cerberus.org/) - input validation and normalization
* [lxml](http://lxml.de/) - XML parsing
* [Jinja2](http://jinja.pocoo.org/) - templating
* [Requests](http://docs.python-requests.org/) - HTTP requests
* [zplgrf](https://github.com/kylemacfarlane/zplgrf) - PNG to ZPL conversion
* [unidecode](https://pypi.python.org/pypi/Unidecode) - Remove accents from ZPL



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/akretion/roulier",
    "name": "roulier",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "carrier,logistics,delivery",
    "author": "Hparfr <https://github.com/hparfr>",
    "author_email": "roulier@hpar.fr",
    "download_url": "https://files.pythonhosted.org/packages/7a/6b/ffefbfbdf8418f047786cdac090e49b64fd104374314f66f5640be630ec5/roulier-1.1.0.tar.gz",
    "platform": "",
    "description": "Roulier\n===\n\nRoulier is a shipping library written in Python for sending parcels.\nRoulier will get a label + tracking number to your carrier for you.\n\n\n![big picture](overview.svg)\n\n\n* Roulier runs on your server and call each carrier API directly.\n* You have to use your own credentials provided by each carriers.\n* Roulier is Open Source software, AGPL-3\n* Roulier integrate a multitude of carriers\n    * French La Poste\n    * French DPD\n    * French GLS\n    * French Chronopost\n    * more to come... (geodis, kuehne...)\n\n### Installation\n\nThis is not compatible with python 2.7.\nPlease use version < 1.0.0 (python2 branch) in that case.\n\n### Usage\n\n```python\nfrom roulier import roulier\n\npayload= {\n\t\"auth\": {\n\t\t\"login\": \"12345\",\n\t\t\"password\": \"password\",\n\t},\n\t\"service\": {\n\t\t\"productCode\": \"COL\"\n\t},\n\t\"parcels\": [{\n\t\t\"weight\": 3.4,\n\t}],\n\t\"to_address\": {\n\t\t\"firstName\": \"Hparfr\"\n\t\t\"street1\": \"35 b Rue Montgolfier\"\n\t\t\"city\": \"Villeurbanne\"\n        \"country\": \"FR\",\n        \"zip\": \"69100\"\n   \t},\n   \t\"from_address\": {\n\t\t\"fristName\": \"Akretion France\"\n\t\t\"street1\": \"35 b Rue Montgolfier\"\n\t\t\"city\": \"Villeurbanne\"\n        \"country\": \"FR\",\n        \"zip\": \"69100\"\n   \t},\n}\n# first parameter is the carrier type.\n# second is the action and then the parameters needed by the action\nresponse = roulier.get('laposte_fr', 'get_label', payload)\n\n\nprint(response)\n\n```\n\n\nGet supported carriers and related actions:\n```python\nfrom roulier import roulier\nprint(roulier.get_carriers_action_available())\n```\n\n### Known Issues\n#### French GLS carrier :\n* The glsbox webservice only manage Basic products : BP, EBP, GBP\n* In the rest webservice, the incoterms don't work\n\n\n### Contributors\n\n\n* [@hparfr](https://github.com/hparfr) ([Akretion.com](https://akretion.com))\n* [@damdam-s](https://github.com/damdam-s) ([Camp2Camp.com](http://camptocamp.com))\n* [@bealdav](https://github.com/bealdav) ([Akretion.com](https://akretion.com))\n* [@DylannCordel](https://github.com/DylannCordel) ([Webu.coop](https://www.webu.coop))\n* [@florian-dacosta](https://github.com/florian-dacosta) ([Webu.coop](https://akretion.com))\n\n\n### Dependencies\n\n* [Cerberus](http://docs.python-cerberus.org/) - input validation and normalization\n* [lxml](http://lxml.de/) - XML parsing\n* [Jinja2](http://jinja.pocoo.org/) - templating\n* [Requests](http://docs.python-requests.org/) - HTTP requests\n* [zplgrf](https://github.com/kylemacfarlane/zplgrf) - PNG to ZPL conversion\n* [unidecode](https://pypi.python.org/pypi/Unidecode) - Remove accents from ZPL\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Label parcels without pain",
    "version": "1.1.0",
    "split_keywords": [
        "carrier",
        "logistics",
        "delivery"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "feb7722165150e11f4eaf4689de8a813",
                "sha256": "68dcc1f0bcc450c57a9a709be71c7f8f11d5ebbc98416c347cfa7a55c975df7d"
            },
            "downloads": -1,
            "filename": "roulier-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "feb7722165150e11f4eaf4689de8a813",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 99527,
            "upload_time": "2021-04-02T08:59:06",
            "upload_time_iso_8601": "2021-04-02T08:59:06.823846Z",
            "url": "https://files.pythonhosted.org/packages/18/3b/2457dc65313475e010893724973d90479cc66d7fa0f73ca96e6c5d9a3ffb/roulier-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bd46cdc8c4bcf12378c5632e78d28ff6",
                "sha256": "96cdc2cefda1d527a98159dafb60ab390643ebe7fb5ce513e9fdd837db6a11e8"
            },
            "downloads": -1,
            "filename": "roulier-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bd46cdc8c4bcf12378c5632e78d28ff6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 57081,
            "upload_time": "2021-04-02T08:59:07",
            "upload_time_iso_8601": "2021-04-02T08:59:07.892590Z",
            "url": "https://files.pythonhosted.org/packages/7a/6b/ffefbfbdf8418f047786cdac090e49b64fd104374314f66f5640be630ec5/roulier-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-02 08:59:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "akretion",
    "github_project": "roulier",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "Cerberus",
            "specs": [
                [
                    "==",
                    "1.1"
                ]
            ]
        },
        {
            "name": "jinja2",
            "specs": [
                [
                    "==",
                    "2.11.3"
                ]
            ]
        }
    ],
    "lcname": "roulier"
}
        
Elapsed time: 0.01300s