Welcome to ePages provisioning’s documentation!¶

Contents:

ePages provisioning¶

Python library for calling ePages provisioning services

Free software: MIT license
Documentation: https://epages-provisioning.readthedocs.io.

Features¶

ePages SimpleProvisioningService for easy shop creation, modifying and deletion

Credits¶

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

[ ~ Dependencies scanned by PyUp.io ~ ]

Installation¶

Stable release¶

To install ePages provisioning, run this command in your terminal:

$ pip install epages_provisioning

This is the preferred method to install ePages provisioning, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for ePages provisioning can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/tswfi/epages_provisioning

Or download the tarball:

$ curl  -OL https://github.com/tswfi/epages_provisioning/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

There are three different ways to use this module.

SimpleProvisioningService
- Simple soap service for handling the shop data
- does not support Attributes but can handle most of the required stuff
ShopConfigService
- bit more complete service that can add extra attributes to the shop
Shop
- pythonic way of calling ShopConfigService

Shop¶

Shop uses the ShopConfigService as a “transport” layer.

Create new shop¶

from epages_provisioning.provisioning import ShopConfigService
from epages_provisioning.shop import Shop
sc = ShopConfigService(
    server = "example.com",
    provider = "Distributor",
    username = "admin",
    password = "admin",
)

# this wont create the shop yet
shop = Shop(Alias="MyTestShop", provisioning=sc)
# shop type is mandatory
shop.ShopType="MinDemo"
# create the shop
shop.create()
# access the shop attributes, and change them as required
shop.IsTrialShop = False
# apply the changes to the server
shop.apply()
# get one attribute from shop (particulary useful if you can also extend
# the ePages end, for example add attribute SSO_URL to shop ;)
shop.get_shop_attribute('CreationDate')
# or set a attribute
shop.set_shop_attribute('GrantServiceAccessUntil', '2100-01-01')

Mark the shop for deletion¶

Mark the shop for delete, ePages will periodically check for shops that have been marked for deletion for long enough and will delete them

# this will call apply automatically
# WARNING: this will also do a refresh from the server, you should call
# apply before to prevent losing information in our shop object
shop.mark_for_delete()
# and reverse delete
shop.mark_for_delete(mark=False)

Reset merchants password¶

Only the super merchant password can be resetted.

# this will call apply automatically
# WARNING: this will also do a refresh from the server, you should call
# apply before to prevent losing information in our shop object
shop.reset_merchant_pass(newpass="hunter2")

Rename shop¶

This will change the shops alias and thus all the url structures, not really recommended for a live shop.

# this will call apply automatically
# WARNING: this will also do a refresh from the server, you should call
# apply before to prevent losing information in our shop object
shop.rename("MyOtherTestShop")

Delete shop¶

Totally remove the shop

shop.delete(shopref=True)

SimpleProvisioningService¶

Create new shop¶

from epages_provisioning import provisioning
sp = provisioning.SimpleProvisioningService(
    server = "example.com",
    provider = "Distributor",
    username = "admin",
    password = "admin",
)
shop = sp.get_createshop_obj(
    {
        'Alias': 'TestShop1',
        'ShopType': 'MinDemo',
    }
)
sp.create(shop)

Get shop info¶

from epages_provisioning import provisioning
sp = provisioning.SimpleProvisioningService(
    server = "example.com",
    provider = "Distributor",
    username = "admin",
    password = "admin",
)
shop = sp.get_shopref_obj(
    {
        'Alias': 'TestShop1',
    }
)
shopinfo = sp.get_info(shop)

ShopConfigService¶

Create new shop¶

from epages_provisioning import provisioning
sc = provisioning.ShopConfigService(
    server = "example.com",
    provider = "Distributor",
    username = "admin",
    password = "admin",
)
shop = sc.get_createshop_obj(
    {
        'Alias': 'TestShop1',
        'ShopType': 'MinDemo',
    }
)
sc.create(shop)

Contributing¶

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

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/tswfi/epages_provisioning/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

ePages provisioning could always use more documentation, whether as part of the official ePages provisioning docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/tswfi/epages_provisioning/issues.

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.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

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

Fork the epages_provisioning repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/epages_provisioning.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv epages_provisioning
$ cd epages_provisioning/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 epages_provisioning tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

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

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests. and the tests should pass ;)
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_epages_provisioning

Releasing new version¶

When you are ready to release a new version follow these steps:

Merge all changes that should be included in the new release to master. And checkout master.
Update HISTORY.rst with the new version number and changes. And commit your changes to master.
run:
```
$ bumpversion patch|minor|major
```
push to master with tags to trigger deploy:
```
$ git push --tags
$ git push
```

This will build the tag and when it is successfull will also deploy to pypi and testpypi

Credits¶

Development Lead¶

Tatu Wikman <tatu.wikman@gmail.com>

Contributors¶

None yet. Why not be the first?

History¶

1.0.2 (2021-01-04)¶

remove last remrants of travis from docs
fix readme in built package
retest deploy process

1.0.1 (2021-01-04)¶

drop travis and switch to github actions for pypi publish
fix pypi and docs build

1.0.0 (2021-01-04)¶

drop support for python 2.7
update zeep to 4.0.0

0.5.0 (2018-10-02)¶

added two new methods get_shop_attribute and set_shop_attribute to shop class
fixed some documentation typos
fixed some code comments
updated dev requirements via pyup

0.4.0 (2018-09-10)¶

update zeep to 3.1.0
added coveralls to testsuite
ShopAddress attributes to shop class
update to ShopConfigService12, getAllInfo is now fixed

0.3.0 (2017-12-22)¶

added “shop” class which is a pythonic wrapper over the shopconfigservice

0.2.1 (2017-12-19)¶

fixed AddtionalAttributes and SecondaryDomains
restructuring

0.2.0 (2017-12-08)¶

First “working” release

0.1.2 through 0.1.7 (2017-12-08)¶

Travis deployment tests

0.1.0 (2017-12-05)¶

First release on PyPI.

Welcome to ePages provisioning’s documentation!¶

ePages provisioning¶

Features¶

Credits¶

Installation¶

Stable release¶

From sources¶

Usage¶

Shop¶

Create new shop¶

Mark the shop for deletion¶

Reset merchants password¶

Rename shop¶

Delete shop¶

SimpleProvisioningService¶

Create new shop¶

Get shop info¶

ShopConfigService¶

Create new shop¶

Contributing¶

Types of Contributions¶

Report Bugs¶

Fix Bugs¶

Implement Features¶

Write Documentation¶

Submit Feedback¶

Get Started!¶

Pull Request Guidelines¶

Tips¶

Releasing new version¶

Credits¶

Development Lead¶

Contributors¶

History¶

1.0.2 (2021-01-04)¶

1.0.1 (2021-01-04)¶

1.0.0 (2021-01-04)¶

0.5.0 (2018-10-02)¶

0.4.0 (2018-09-10)¶

0.3.0 (2017-12-22)¶

0.2.1 (2017-12-19)¶

0.2.0 (2017-12-08)¶

0.1.2 through 0.1.7 (2017-12-08)¶

0.1.0 (2017-12-05)¶

Indices and tables¶