~mdkcore/jackplug

49195486982247f47d796616d9221be02dd13493 — Rodrigo Oliveira 4 years ago b1a3f02
PA-2589 - Adjust README.md and set requirements

- Python 2.7.16 is the minimal python2 requirement;
- Python 3.8.0 is the recommended python version;
- Pipfile and Pipfile.lock were added for python3 use.
4 files changed, 188 insertions(+), 7 deletions(-)

A Pipfile
A Pipfile.lock
M README.md
M setup.py
A Pipfile => Pipfile +16 -0
@@ 0,0 1,16 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

# TODO add simb-pilsner to [packages] when having the package
[dev-packages]
simb-pilsner = {editable = true,path = "./../pilsner/python"}
jackplug = {editable = true,path = "."}

[packages]
pyzmq = "==18.1.0"
tornado = "==4.5.3"

[requires]
python_version = "3.8"

A Pipfile.lock => Pipfile.lock +133 -0
@@ 0,0 1,133 @@
{
    "_meta": {
        "hash": {
            "sha256": "835f20f5bee1770b5464b4175188a9cb7d6b87459934e64fd6c93a64e2b60966"
        },
        "pipfile-spec": 6,
        "requires": {
            "python_version": "3.8"
        },
        "sources": [
            {
                "name": "pypi",
                "url": "https://pypi.org/simple",
                "verify_ssl": true
            }
        ]
    },
    "default": {
        "pyzmq": {
            "hashes": [
                "sha256:01636e95a88d60118479041c6aaaaf5419c6485b7b1d37c9c4dd424b7b9f1121",
                "sha256:021dba0d1436516092c624359e5da51472b11ba8edffa334218912f7e8b65467",
                "sha256:0463bd941b6aead494d4035f7eebd70035293dd6caf8425993e85ad41de13fa3",
                "sha256:05fd51edd81eed798fccafdd49c936b6c166ffae7b32482e4d6d6a2e196af4e6",
                "sha256:1fadc8fbdf3d22753c36d4172169d184ee6654f8d6539e7af25029643363c490",
                "sha256:22efa0596cf245a78a99060fe5682c4cd00c58bb7614271129215c889062db80",
                "sha256:260c70b7c018905ec3659d0f04db735ac830fe27236e43b9dc0532cf7c9873ef",
                "sha256:2762c45e289732d4450406cedca35a9d4d71e449131ba2f491e0bf473e3d2ff2",
                "sha256:2fc6cada8dc53521c1189596f1898d45c5f68603194d3a6453d6db4b27f4e12e",
                "sha256:343b9710a61f2b167673bea1974e70b5dccfe64b5ed10626798f08c1f7227e72",
                "sha256:41bf96d5f554598a0632c3ec28e3026f1d6591a50f580df38eff0b8067efb9e7",
                "sha256:856b2cdf7a1e2cbb84928e1e8db0ea4018709b39804103d3a409e5584f553f57",
                "sha256:85b869abc894672de9aecdf032158ea8ad01e2f0c3b09ef60e3687fb79418096",
                "sha256:93f44739db69234c013a16990e43db1aa0af3cf5a4b8b377d028ff24515fbeb3",
                "sha256:98fa3e75ccb22c0dc99654e3dd9ff693b956861459e8c8e8734dd6247b89eb29",
                "sha256:9a22c94d2e93af8bebd4fcf5fa38830f5e3b1ff0d4424e2912b07651eb1bafb4",
                "sha256:a7d3f4b4bbb5d7866ae727763268b5c15797cbd7b63ea17f3b0ec1067da8994b",
                "sha256:b645a49376547b3816433a7e2d2a99135c8e651e50497e7ecac3bd126e4bea16",
                "sha256:cf0765822e78cf9e45451647a346d443f66792aba906bc340f4e0ac7870c169c",
                "sha256:dc398e1e047efb18bfab7a8989346c6921a847feae2cad69fedf6ca12fb99e2c",
                "sha256:dd5995ae2e80044e33b5077fb4bc2b0c1788ac6feaf15a6b87a00c14b4bdd682",
                "sha256:e03fe5e07e70f245dc9013a9d48ae8cc4b10c33a1968039c5a3b64b5d01d083d",
                "sha256:ea09a306144dff2795e48439883349819bef2c53c0ee62a3c2fae429451843bb",
                "sha256:f4e37f33da282c3c319849877e34f97f0a3acec09622ec61b7333205bdd13b52",
                "sha256:fa4bad0d1d173dee3e8ef3c3eb6b2bb6c723fc7a661eeecc1ecb2fa99860dd45"
            ],
            "index": "pypi",
            "version": "==18.1.0"
        },
        "tornado": {
            "hashes": [
                "sha256:5ef073ac6180038ccf99411fe05ae9aafb675952a2c8db60592d5daf8401f803",
                "sha256:6d14e47eab0e15799cf3cdcc86b0b98279da68522caace2bd7ce644287685f0a",
                "sha256:92b7ca81e18ba9ec3031a7ee73d4577ac21d41a0c9b775a9182f43301c3b5f8e",
                "sha256:ab587996fe6fb9ce65abfda440f9b61e4f9f2cf921967723540679176915e4c3",
                "sha256:b36298e9f63f18cad97378db2222c0e0ca6a55f6304e605515e05a25483ed51a"
            ],
            "index": "pypi",
            "version": "==4.5.3"
        }
    },
    "develop": {
        "jackplug": {
            "editable": true,
            "path": "."
        },
        "ordereddict": {
            "hashes": [
                "sha256:1c35b4ac206cef2d24816c89f89cf289dd3d38cf7c449bb3fab7bf6d43f01b1f"
            ],
            "version": "==1.1"
        },
        "pyasn1": {
            "hashes": [
                "sha256:62cdade8b5530f0b185e09855dd422bc05c0bbff6b72ff61381c09dac7befd8c",
                "sha256:a9495356ca1d66ed197a0f72b41eb1823cf7ea8b5bd07191673e8147aecf8604"
            ],
            "version": "==0.4.7"
        },
        "pysmb": {
            "hashes": [
                "sha256:8b364446a9998a7edc128bdf77e3281df613f4951beb69dbd221525f8748bbd3"
            ],
            "version": "==1.1.27"
        },
        "pyzmq": {
            "hashes": [
                "sha256:01636e95a88d60118479041c6aaaaf5419c6485b7b1d37c9c4dd424b7b9f1121",
                "sha256:021dba0d1436516092c624359e5da51472b11ba8edffa334218912f7e8b65467",
                "sha256:0463bd941b6aead494d4035f7eebd70035293dd6caf8425993e85ad41de13fa3",
                "sha256:05fd51edd81eed798fccafdd49c936b6c166ffae7b32482e4d6d6a2e196af4e6",
                "sha256:1fadc8fbdf3d22753c36d4172169d184ee6654f8d6539e7af25029643363c490",
                "sha256:22efa0596cf245a78a99060fe5682c4cd00c58bb7614271129215c889062db80",
                "sha256:260c70b7c018905ec3659d0f04db735ac830fe27236e43b9dc0532cf7c9873ef",
                "sha256:2762c45e289732d4450406cedca35a9d4d71e449131ba2f491e0bf473e3d2ff2",
                "sha256:2fc6cada8dc53521c1189596f1898d45c5f68603194d3a6453d6db4b27f4e12e",
                "sha256:343b9710a61f2b167673bea1974e70b5dccfe64b5ed10626798f08c1f7227e72",
                "sha256:41bf96d5f554598a0632c3ec28e3026f1d6591a50f580df38eff0b8067efb9e7",
                "sha256:856b2cdf7a1e2cbb84928e1e8db0ea4018709b39804103d3a409e5584f553f57",
                "sha256:85b869abc894672de9aecdf032158ea8ad01e2f0c3b09ef60e3687fb79418096",
                "sha256:93f44739db69234c013a16990e43db1aa0af3cf5a4b8b377d028ff24515fbeb3",
                "sha256:98fa3e75ccb22c0dc99654e3dd9ff693b956861459e8c8e8734dd6247b89eb29",
                "sha256:9a22c94d2e93af8bebd4fcf5fa38830f5e3b1ff0d4424e2912b07651eb1bafb4",
                "sha256:a7d3f4b4bbb5d7866ae727763268b5c15797cbd7b63ea17f3b0ec1067da8994b",
                "sha256:b645a49376547b3816433a7e2d2a99135c8e651e50497e7ecac3bd126e4bea16",
                "sha256:cf0765822e78cf9e45451647a346d443f66792aba906bc340f4e0ac7870c169c",
                "sha256:dc398e1e047efb18bfab7a8989346c6921a847feae2cad69fedf6ca12fb99e2c",
                "sha256:dd5995ae2e80044e33b5077fb4bc2b0c1788ac6feaf15a6b87a00c14b4bdd682",
                "sha256:e03fe5e07e70f245dc9013a9d48ae8cc4b10c33a1968039c5a3b64b5d01d083d",
                "sha256:ea09a306144dff2795e48439883349819bef2c53c0ee62a3c2fae429451843bb",
                "sha256:f4e37f33da282c3c319849877e34f97f0a3acec09622ec61b7333205bdd13b52",
                "sha256:fa4bad0d1d173dee3e8ef3c3eb6b2bb6c723fc7a661eeecc1ecb2fa99860dd45"
            ],
            "index": "pypi",
            "version": "==18.1.0"
        },
        "simb-pilsner": {
            "editable": true,
            "path": "./../pilsner/python"
        },
        "tornado": {
            "hashes": [
                "sha256:5ef073ac6180038ccf99411fe05ae9aafb675952a2c8db60592d5daf8401f803",
                "sha256:6d14e47eab0e15799cf3cdcc86b0b98279da68522caace2bd7ce644287685f0a",
                "sha256:92b7ca81e18ba9ec3031a7ee73d4577ac21d41a0c9b775a9182f43301c3b5f8e",
                "sha256:ab587996fe6fb9ce65abfda440f9b61e4f9f2cf921967723540679176915e4c3",
                "sha256:b36298e9f63f18cad97378db2222c0e0ca6a55f6304e605515e05a25483ed51a"
            ],
            "index": "pypi",
            "version": "==4.5.3"
        }
    }
}

M README.md => README.md +34 -5
@@ 6,8 6,36 @@ as default: */tmp/jack.plug*), and **tcp** (*TCPEndpoint*, using *3559* as the d
port number).

## Requirements
    * pyzmq 15.4.0
    * simb.pilsner
* pyzmq 18.1.0
* tornado 4.5.3
* simb.pilsner

## Installation instructions for development:
- Install pyenv and pipenv:
    - macos:

            $ brew install pyenv pipenv

    - linux:
        - Install pyenv from your package manager, or follow [these instructions](https://github.com/pyenv/pyenv#basic-github-checkout)

        - Install pipenv:

                $ pip install -U --user pipenv

- Create a new python virtualenv:

        $ pipenv shell

    pipenv should install the required python version and activate a new virtualenv; if it not occurs, run the following and repeat the command above:

        $ pyenv install 3.8.0
        $ pyenv local 3.8.0
        $ pipenv --python 3.8.0

- Finally activate the virtualenv and you are all set:

        $ pipenv install --dev

## Examples
An example of the use of this library can be found on the *examples* folder, and


@@ 16,8 44,9 @@ running them is pretty straightforward:
Run *examples/jack.py* and *examples/plug.py*, in different terminals. You
should set the same transport argument on both of them (**ipc** or **tcp**).

```bash
$ python examples/jack.py ipc
```
    $ python examples/jack.py ipc
    --
    $ python examples/plug.py ipc
```bash
$ python examples/plug.py ipc
```

M setup.py => setup.py +5 -2
@@ 7,7 7,10 @@ setup(
    author='Rodrigo Oliveira',
    author_email='rodrigo@byne.com.br',
    packages=find_packages(),
    install_requires=['simb.pilsner',
                      'pyzmq==15.4.0'],
    install_requires=[
        'simb.pilsner',
        'pyzmq==18.1.0',
        'tornado==4.5.3'
    ],
    long_description=open('README.md').read(),
)