Discussion on PyStackAPI project.

[wchistow]

Write something here.

[Peter-developer01]

This is cool project. Maybe you want add me to a contributors, I know Python.

This can be great experience for you and me.

[wchistow]

@Peter-developer01, warning: I've added the code checking with MyPy on push - https://github.com./wchistow/pystackapi/actions/workflows/mypy.yml.

[wchistow]

@Peter-developer01, note: I've added auto running tests on push. So, before each commit, run mypy and tests. MyPy runs by command python -m mypy ./src/ --config-file ./mypy.ini, requirements is mypy and types-requests. About tests, they run by cd tests; python main.py, and the requirements may be installed by python -m pip install rich==13.4.2; python -m pip install -r ./requirements.txt.

[Peter-developer01]

@wchistow before each commit or before each push?

[wchistow]

@Peter-developer01, better before committing, so as not to commit non-working code.

[Peter-developer01]

@wchistow ok.

[wchistow]

I think, that this code from example getting general information of site is not very beautiful:

response = site.get_info()

information = response['items'][0]
#                     ^^^^^^^^^^^^

My idea is that get_info and get_<singular_noun> returns Item, and, accordingly, get_<plural_noun> returns list[Item] . Remind you that the API response contains the following keys:

• items
• has_more
• quota_max
• quota_remaining

So, in my solution these keys, except items, are missing.

But maybe they are not so important?

So, I want to know your opinion, @Peter-developer01, is it worth doing this.

[wchistow]

I've come up with a way out! Site.get returns raw dict, but Site.get_<singular_noun> returns Item and get_<plural_noun> returns list[Item].

[nchistov]

Please add contributors guide file.

[wchistow]

Added - f88af4a

[Peter-developer01]

@wchistow sorry, I'm a little busy now.

[wchistow]

How long will you be busy?

[Peter-developer01]

I sometimes can freely contribute, but, if you want to know the exact date... this is approximately and and a half year.

BUT: I sometimes are free, so I can sometimes free contribute.

[wchistow]

OK

[wchistow]

@nchistov, can you delete your fork of this project? In my opinion, this fork is not necessary now.

[nchistov]

Yes, I delete it.

[wchistow]

@nchistov @Peter-developer01 Hooray, PyStackAPI 0.1.0 is here!

[Peter-developer01]

Good! 🎉

[wchistow]

See question about it on StackApps: https://stackapps.com/q/10408/116701.

[Peter-developer01]

Good, I've suggested an edit.

[wchistow]

@nchistov, @Peter-developer01, we are starting the development of version 0.2.0! Join!

[wchistow]

@Peter-developer01, see contributors' guide (cd tests; python main.py).

[wchistow]

@Peter-developer01, about access token: I've wrote an answer on RuSO about getting it. I wrote it for two days!

[Peter-developer01]

@wchistow Cool!

[wchistow]

@Peter-developer01, I've added (aefbd71) some tasks to the ToDo, you can to do them.

[wchistow]

@Peter-developer01, as the example of the POST-method you can use the add_answer method.

[Peter-developer01]

@wchistow just ignore that. No need to ask what is this.

[wchistow]

@Peter-developer01, when you add some method to the library, don't forget to add it to the CHANGELOG.md file.

[Peter-developer01]

Okay.

[wchistow]

All ToDo tasks have done, and, if you don't have any more ideas for it, tomorrow the 0.2.0 version will be out.

[wchistow]

@Peter-developer01, @nchistov, I'm going to add StackExchange chat API to the next version of PyStackAPI (0.3.0). Information about its interface is quite difficult to find (there is not a word about it in the official documentation!), but I found this file: https://github.com./Manishearth/ChatExchange/blob/master/docs/se-chat-interface.md. We'll start soon)

[wchistow]

@Peter-developer01, I think it would be easier to just make a wrapper for the finished library 😉

[Peter-developer01]

Yeah it is a lot easier. If you test it yourself, you can find what you don't like and rewrite it to be easier (I mean, wrapper it) ;)

[wchistow]

rewrite it - And first I'll fix DeprecationWarning ;)

[Peter-developer01]

Feel free to mess with the library and see what looks better and natural. ;)

[Peter-developer01]

I have an idea... How about extend the original ChatExchange with functions to read transcript, messages, etc.? It would be good, as now I couldn't find such a feature, or at least it is not obvious how to use it.

[wchistow]

@Peter-developer01, @nchistov, today is the PyStackAPI's birthday! The first commit was created on May 28 2023, a year ago!

[Peter-developer01]

Yay!