API wrapper for versatileapi in Python
Project description
simpleverse
API wrapper for versatileapi in Python
Install
pip install simpleverse
CLI
Workaround for simpleverse's CLI
$ simv -h
usage: simv [-h]
{create_like,cl,create_user,cu,update_user,uu,get_like,gl,get_image,gi,get_post,gp,get_user,gu,submit_post,sp,submit_image,si}
...
Simple command for sending requests to versatileapi
positional arguments:
{create_like,cl,create_user,cu,update_user,uu,get_like,gl,get_image,gi,get_post,gp,get_user,gu,submit_post,sp,submit_image,si}
create_like (cl)
create_user (cu)
update_user (uu)
get_like (gl)
get_image (gi)
get_post (gp)
get_user (gu)
submit_post (sp)
submit_image (si)
optional arguments:
-h, --help show this help message and exit
$ simv cu -n eggplants -d "https://github.com/eggplants/simpleverseを書きました。"
b6e4ae19fc2c59ce55c726de44a40dc825faa04d
$ simv gu -u b6e4ae19fc2c59ce55c726de44a40dc825faa04d
{
'id': 'b6e4ae19fc2c59ce55c726de44a40dc825faa04d',
'_created_at': '2021-09-19T04:35:11.765+00:00',
'_updated_at': '2021-09-19T04:35:11.765+00:00',
'_user_id': 'b6e4ae19fc2c59ce55c726de44a40dc825faa04d',
'description': 'https://github.com/eggplants/simpleverseを書きました。',
'name': 'eggplants'
}
$ simv sp "コレはテストです"
00210022-a452-4be7-a873-d369b1bf8d70
$ simv gp -p 00210022-a452-4be7-a873-d369b1bf8d70
{
'id': '00210022-a452-4be7-a873-d369b1bf8d70',
'_created_at': '2021-09-19T04:45:42.017+00:00',
'_updated_at': '2021-09-19T04:45:42.017+00:00',
'_user_id': 'b6e4ae19fc2c59ce55c726de44a40dc825faa04d',
'text': 'コレはテストです'
}
$ simv uu -n eggplants -d "こんにちは。https://github.com/eggplants/simpleverseを書きました。"
b6e4ae19fc2c59ce55c726de44a40dc825faa04d
$ simv gu -u b6e4ae19fc2c59ce55c726de44a40dc825faa04d
{
'id': 'b6e4ae19fc2c59ce55c726de44a40dc825faa04d',
'_created_at': '2021-09-19T04:35:11.765+00:00',
'_updated_at': '2021-09-19T04:46:53.659+00:00',
'_user_id': 'b6e4ae19fc2c59ce55c726de44a40dc825faa04d',
'description': 'こんにちは。https://github.com/eggplants/simpleverseを書きました。',
'name': 'eggplants'
}
$ # All posts by a specific user
$ simv gp | jq '.[]|select(._user_id=="b6e4ae19fc2c59ce55c726de44a40dc825faa04d")'
{
"_created_at": "2021-09-18T18:50:33.316+00:00",
"_updated_at": "2021-09-18T18:50:33.316+00:00",
"_user_id": "b6e4ae19fc2c59ce55c726de44a40dc825faa04d",
"id": "12d7d6c5-1412-4299-9fe0-4e11c5261aab",
"text": "test"
}
{
"_created_at": "2021-09-19T04:10:35.054+00:00",
"_updated_at": "2021-09-19T04:10:35.054+00:00",
"_user_id": "b6e4ae19fc2c59ce55c726de44a40dc825faa04d",
"id": "81dd0981-de48-47b6-bb81-2bc33579d0d1",
"text": "hello woooooooold!"
}
{
"_created_at": "2021-09-19T04:14:44.837+00:00",
"_updated_at": "2021-09-19T04:14:44.837+00:00",
"_user_id": "b6e4ae19fc2c59ce55c726de44a40dc825faa04d",
"id": "b281751f-03a9-47b0-ace1-2dc1be620a2a",
"text": "hello woooooooold!\n(this post submitted by https://git.io/JzmhD)"
}
{
"_created_at": "2021-09-19T04:39:57.808+00:00",
"_updated_at": "2021-09-19T04:39:57.808+00:00",
"_user_id": "b6e4ae19fc2c59ce55c726de44a40dc825faa04d",
"id": "d2f875a4-540e-4332-ae4e-5ac80d435449",
"text": "a"
}
{
"_created_at": "2021-09-19T04:45:42.017+00:00",
"_updated_at": "2021-09-19T04:45:42.017+00:00",
"_user_id": "b6e4ae19fc2c59ce55c726de44a40dc825faa04d",
"id": "00210022-a452-4be7-a873-d369b1bf8d70",
"text": "コレはテストです"
}
Library
Classes and its methods of simpleverse
from simpleverse import (
CreateLike,
CreateUser,
GetImageInfo,
GetLikeInfo,
GetPostInfo,
GetUserInfo,
SubmitImage,
SubmitPost,
)
class CreateLike(BaseVerseRequests):
def create_like(self, post_id: str, like_count: int) -> str: ...
class CreateUser(BaseVerseRequests):
def create_user(self, name: str, description: str) -> str: ...
def update_user(self, name: str, description: str) -> str: ...
class GetImageInfo(BaseVerseRequests):
def get_image_all(self) -> List[ImageInfo]: ...
def get_image(self, image_id: str) -> ImageInfo: ...
def get_image_OData(
self,
filter_: Optional[str] = ...,
order_by: Optional[str] = ...,
limit: Optional[int] = ...,
skip: Optional[int] = ...,
) -> List[ImageInfo]: ...
class GetLikeInfo(BaseVerseRequests):
def get_like_all(self) -> List[LikeInfo]: ...
def get_like(self, post_id: str) -> LikeInfo: ...
def get_like_OData(
self,
filter_: Optional[str] = ...,
order_by: Optional[str] = ...,
limit: Optional[int] = ...,
skip: Optional[int] = ...,
) -> List[LikeInfo]: ...
class GetPostInfo(BaseVerseRequests):
def get_post_all(self) -> List[PostInfo]: ...
def get_post(self, post_id: str) -> PostInfo: ...
def get_post_OData(
self,
filter_: Optional[str] = ...,
order_by: Optional[str] = ...,
limit: Optional[int] = ...,
skip: Optional[int] = ...,
) -> List[PostInfo]: ...
class GetUserInfo(BaseVerseRequests):
def get_user_all(self) -> List[UserInfo]: ...
def get_user(self, user_id: str) -> UserInfo: ...
def get_user_OData(
self,
filter_: Optional[str] = ...,
order_by: Optional[str] = ...,
limit: Optional[int] = ...,
skip: Optional[int] = ...,
) -> List[UserInfo]: ...
class SubmitImage(BaseVerseRequests):
def submit_image(self, image_data: str, post_id: str) -> str: ...
class SubmitPost(BaseVerseRequests):
def submit_post(
self,
text: str,
rep_user_id: Optional[str] = ...,
rep_post_id: Optional[str] = ...,
test: bool = ...,
) -> str: ...
Links
Docs
- HawkClaws/versatileapi
- API generator
- エンジニア・プログラマにしか使えない SNS を作ってみた話
- Author's article
- Swagger
- Versatileapi's schema in Swagger
WebUI Clients (deploying somewhare)
- chamegashi/Engineer_SNS_Test_Site
- dala00/engineer-sns-client
- hir0o/sns-for-engineer
- lightwill/sns
- Posts of spesific user:
https://lightwill.tokyo/dev/sns/?selectUserId={userid}
- Posts of spesific user:
- nison/json-sns-viewer
- mehm8128/twitter-for-engineer
- standard-software/programmer-only-sns
- voidproc/engineer-sns-client
- yosket/engineer-sns
CUI Clients
- daiji-tsutsui/Beelzebub
- Ruby
- elderica/esns
- Racket
- javaboy-github/only-programer-sns-client
- Golang
- nyanpyou106/versatileapisns_client
- Python
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
simpleverse-0.5.tar.gz
(10.5 kB
view hashes)
Built Distribution
simpleverse-0.5-py3-none-any.whl
(12.3 kB
view hashes)
Close
Hashes for simpleverse-0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f901f81234bdbff598eb497fc2bdc58cbdcab273e167acf51da4069657d31bc |
|
MD5 | 355117a91d488e8157aaf68289dbb5df |
|
BLAKE2b-256 | e2d2076a0baf5951745e411f0ad289f13cc7f0527034a0d0b37bc9d925f709d8 |