mainflux / sdk-py Goto Github PK

Finish Group API support, what is missing.

After releasing the first package release, upload it to PyPI and make sure that pip installation - i.e. that the package is successfully pulled from PyPI and installed to the local machine via pip install mainflux.

ENHANCEMENT

1. Describe the enhancement you are requesting. Enhancements include:

   • Linting with flake8
   • code refactor

2. Should-have.

Hello, @drasko!

1. What were you trying to achieve?
   do: pip install mainflux on Windows (try and from cmd, and from vscode) python 3.10
   want to use in vscode +python line from mainflux import SDK (like in readme)

2. What are the expected results?
   to see in repo c:...\python310\site-packages\ folder mainflux with .py files
   and to use line from mainflux import SDK

3. What are the received results?
   Have three folders:
   c:....\python310\site-packages\lib*
   c:....\python310\site-packages\mainflux-0.0.1.dist-info*
   c:....\python310\site-packages\tests*\

and it works only if I use from lib.sdk import SDK because there no dir mainflux

for example here is folder paho and others (to use with import)
c:....\python310\site-packages\paho\

4. What are the steps to reproduce the issue?

5. In what environment did you encounter the issue?
   look upper

6. Additional information you deem important:

What I do to works from mainflux import SDK

• create folder c:....\python310\site-packages\mainflux
• copy folders lib, tests, mainflux-0.0.1.dist-info (from p.3) to folder mainflux
• create in mainflux file __init__.py
• copy to file __init__.py content from file lib\sdk.py

so after these it works:

from mainflux import SDK
default_url = "http://localhost"      <- what is this line for? If it have to change default_url - it's not working
sdk = SDK()

# Example to create an account
mf_resp = sdk.users.create({"email": "<user_email>", "password": "<user_password>"})
if mf_resp.error.status == 0:
    print(mf_resp.value)
else:
    print(mf_resp.error.message)

but I use user.login and change default_url directly in __init__.py

After all is finished tag and create the release

Follow the documentation for API Keys and add those endpoint support in the SDK.

Looks like setup procedure has not been tested, as lib is used for a package dir, while setup.cfg mentions src. Please go through this and similar documents and let's decide if we will call the source directory lib or src is more Python-idiomatic and also what would be the internal structure of this directory.

You can use API generators like pdoc or others.

Release 0.1 version though official GitHub release process.

FEATURE REQUEST

1. Is there an open issue addressing this request? If it does, please add a "+1" reaction to the
   existing issue, otherwise proceed to step 2.

2. Describe the feature you are requesting, as well as the possible use case(s) for it.

README should be rephrased to explain the SDK nicer (a bit better phrasing) and use Markdown formatting and links correctly.

Also, docs index.md should probably contain links (if possible to be generated), and API reference link on README should probably lead directly to this index.md.

Also - it looks like Markdown is not well generated - Methods are in verbatim, and so Markdown on function names is not applied.

3. Indicate the importance of this feature to you (must-have, should-have, nice-to-have).
   Must-have

FEATURE REQUEST

1. Is there an open issue addressing this request? There is no open issue

2. Import request mock in the test used for testing

3. This is a must-have.

Use GithHub Actions to setup CI/testing rules.