Python request API to simplemachinesforum
Project description
python-simplemachinesforum
Python request API to Simple Machines Forum: https://www.simplemachines.org/
Important
A forum is for humans, please use this piece of software only in combination with YOUR OWN FORUM or by order of the forum owner itself to provide a valuable service. Be aware that bots are not tolerated on most boards and its use will lead to a ban.
What does it can?
- It can create a new topic with
new_topic()
on a remote simple machines forum over the network, all it needs is a valid user account to login. - Given a topic ID, toggle the topic's stickiness with
toggle_sticky()
. - Given a subject name and board, return the topic id for the matching topic with
get_topic_id
. - Use the advanced search feature, and return the list of matches with
advanced_search()
. - Given a board, return the topic id for all currently stickied topics with
get_stickied_posts()
.
Installation
pip install simplemachinesforum
https://pypi.org/project/simplemachinesforum/
How to create a new topic?
from simplemachinesforum.simplemachinesforum import SimpleMachinesForum
smf_url = "https://www.any-simplemachinesforum.com"
smf_user = "user_name"
smf_pass = "password"
smf = SimpleMachinesForum(smf_url, smf_user, smf_pass)
# 1 = board id:
smf.new_topic(1, "subject", "This is the message to post!")
Documentation
https://oliver-zehentleitner.github.io/python-simplemachinesforum/
Project, code and downloads:
https://github.com/oliver-zehentleitner/python-simplemachinesforum
Wiki
https://github.com/oliver-zehentleitner/python-simplemachinesforum/wiki
How to report bugs or suggest improvements?
Please open a new issue: https://github.com/oliver-zehentleitner/python-simplemachinesforum/issues
If you report a bug, try first the latest release via download
or with pip install simplemachinesforum --upgrade
. If the issue still exists, provide the error trace, OS
and python version and explain how to reproduce the error. A demo script is appreciated.
Contributing
python-simplemachinesforum
is an open source project which welcomes contributions which can be anything from simple
documentation fixes to new features. To contribute, fork the project on GitHub and send a pull request.
Contributors
We open source!
Commercial Support
Need a Python developer or consulting?
Contact me for a non-binding and free consultation via my company LUCIT from Vienna (Austria).
Donate
Since you are probably a developer yourself, you will understand very well that the creation of open source software is not free - it requires technical knowledge, a lot of time and also financial expenditure.
If you would like to help me to dedicate my time and energy to this project, even small donations are very welcome.
Terra (LUNA, UST, ...): terra1yt34qmmycextztnj9mpt3mnjzqqvl8jtqqq7g9
BTC: 39fS74fvcGnmEk8JUV8bG6P1wkdH29GtsA
DASH: XsRhBuPkXGF9WvifdpkVhTGSmVT4VcuQZ7
ETH: 0x1C15857Bf1E18D122dDd1E536705748aa529fc9C
LTC: LYNzHMFUbee3siyHvNCPaCjqXxjyq8YRGJ
XMR: 85dzsTRh6GRPGVSJoUbFDwAf9uwwAdim1HFpiGshLeKHgj2hVqKtYVPXMZvudioLsuLS1AegkUiQ12jwReRwWcFvF7kDAbF
ZEC: t1WvQMPJMriGWD9qkZGDdE9tTJaawvmsBie
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for simplemachinesforum-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6030948a2cbcaaee55dfeab936a0ed6436fcdebdcc726cb5ecbb5f7a8d7062f5 |
|
MD5 | 265966e7656cf21bfa30e80966591d79 |
|
BLAKE2b-256 | f1c64e4bda3949ca0118245ab6e630005f7c41bb73afff747610f8eb701b3ef8 |