Reverse-engineered Python CLI for DeviantArt Eclipse functionality
Project description
dAEclipse CLI
daeclipse is a reverse-engineered Python library for DeviantArt Eclipse functionality.
This repo also contains a handy CLI to expose and test daeclipse
capabilities.
poetry run daeclipse
Usage: cli.py [OPTIONS] COMMAND [ARGS]...
DeviantArt Eclipse CLI
Options:
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--help Show this message and exit.
Commands:
add-art-to-groups Submit DeviantArt deviation to groups.
hot-tags Return top tags on the hottest deviations.
post-status Post a DeviantArt status.
show-tags Return list of tags for given deviation.
spammer Return information and output for spam report helpdesk ticket creation.
user-comments Retrieve recent comments made by specified user.
Installation
The Python library is available via https://pypi.org/project/daeclipse/
pip install daeclipse
The CLI is only available by downloading / cloning the repo to your local machine:
git clone git@github.com:Pepper-Wood/daeclipse.git
Usage
import daeclipse
# Fetches a list of group names the user is a member of.
# You will need to be logged into DeviantArt and have a chrome page open.
eclipse = daeclipse.Eclipse()
groups, has_more, next_offset, total = eclipse.get_groups("Pepper-Wood", 0)
for group in groups:
print(group.username)
Build Status and Checks
CICD is run thorugh GitHub Actions and makes the below checks on the two components of this repository:
Python Package | OpenAPI Spec | |
---|---|---|
Lint | ||
Test | Coming Soon... | Coming soon... |
Deploy |
Contributing
Contributions are always welcome, no matter how large or small! Before contributing, please read the code of conduct.
If you have a feature request, run into a bug, or are unsure about anything, feel free to submit a GitHub issue.
If you are interested in creating a Pull Request, please read the guide on this repository's development process.
Commit titles on the main
branch follow the emoji-commit-messages naming convention.
Caveats / Disclaimer
DeviantArt's history as a website is storied. Prior to the release of Eclipse, there were two options with creating tooling around its UI:
- The Public DeviantArt API. See accompanying Python wrapper. The API is relatively easy to use - and utilizes OAuth2 for authentication - but its endpoints and functionality are sparce. It also was not updated for some time but now appears to be getting a handful of new endpoints based on the changelog.
- The internal DeviantArt Interactive Fragment Interface (DiFi). DiFi has a wide range of functionality but is volatile/unreliable and difficult to use - especially compared to modern APIs.
On October 2019, DeviantArt announced DeviantArt Eclipse, a new UI (mostly) built in React. There are still a handful of pages on the website that expose the old website (i.e. https://www.deviantart.com/groups/) where functionality hasn't been completely ported. But with the new React UI, DeviantArt brought along a third option for tooling:
- The internal DeviantArt NAPI, currently undocumented. The structure of its endpoints resembles RESTful practices, and authentication is done through scraping a CSRF token on the website or using a user's stored
.deviantart.com
cookies.
The implementation in this library relies on the DeviantArt NAPI. As such, functionality may break without warning depending on whether the internal DeviantArt team makes changes to these endpoints.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for daeclipse_cli-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a72d49194aebe94ff9c61f3336a4060d6514f2a48245cc03cd6713b9b5f2107b |
|
MD5 | cc7730126c12abed04c5803131cbdbe8 |
|
BLAKE2b-256 | e40dc22dec562560e81846ffd36256979526b87e317607e7516524c02c6b7919 |