Welcome to sxcu’s documentation!¶

SCXU is an API wrapper for api located at sxcu.net. Pretty much this documentation covers with some example and API reference. Currently the documentation is in building stage.

Installation¶

SXCU can be installed using pip

pip install sxcu

Examples¶

Uploading a Image to sxcu.net¶

To upload an image foo.png located in the same directory as the script and print the url:

import sxcu
connector = sxcu.SXCU()
result = connector.upload_image("foo.png")
print(result["url"])

Parameters acceped are

upload_image(file[, collection, …])

This uploads image to sxcu

Uploading Image with `og_properties`¶

What is `og_properties`?¶

The Open Graph protocol The Open Graph protocol enables any web page to become a rich object in a social graph.

sxcu.net allows the following properties to be changed for changing the way it embed in apps and websites.

How to use it?¶

Using the class

og_properties(color, description, title)

This is a helper class for main SXCU function.

Reference¶

This it python API reference of the current things implemented.

Python API Reference¶

`SXCU`(subdomain, upload_token, file_sxcu)	The Main class for sxcu.net request
`og_properties`(color, description, title)	This is a helper class for main SXCU function.

Changelog¶

sxcu-v1.0.2¶

[TOB]

sxcu-v1.0.1¶

Fixed an issue in reading .sxcu file. (PR-10)
Fixed __version__ and removed a dependency.

sxcu-v1.0.0¶

New Features¶

Create a new logo.
Added a missing API method image_details().
Fix a bug due to subdomain parsing while using .sxcu files.
Add a missing endpoint of edit_collection().
Fixed a bug in create_link()

For developers¶

Added docs at https://sxcu.syrusdark.website.
Added a few Tests.
Enforce formatting with pre-commit.
Added test Coverage
Linting For Pull Requests Added.

sxcu-v0.1.0-alpha.0¶

Initial release with basic structure.