Installation & Setup¶

For users who haven’t used Python before, check out With uv (Recommended). For more experienced users, a more typical installation documentation is listed below, but I would still recommend using uv.

Installing the Library¶

With pip¶

To install AMQCSLdb via pip:

pip install "git+https://github.com/FieryIceStickie/amqcsldb-py"

Tip

It’s highly recommended to install AMQCSLdb in a virtual environment.

With uv (Recommended)¶

Firstly, install uv. If you don’t have python 3.12+ installed, run

uv python install

After that, cd to the directory you want the project to sit, and run

uv init amq_scripts
cd amq_scripts
uv add "git+https://github.com/FieryIceStickie/amqcsldb-py"

Setting up the script directory¶

Now that you have the library installed, you should set up a script directory to store your scripts in. A CLI tool comes bundled with the library for this purpose. Inside your project, run

Normal

python3 -m amqcsl init

With uv

uv run amqcsl init

It will prompt you for your username and password; this is your amqbot account username and password, not your AMQ account. For more details regarding the CLI, see Command Line.

Making a script file¶

You can choose to do this manually, but AMQCSLdb provides templates to help you skip the boilerplate. Run

Normal

python3 -m amqcsl make scripts/test.py

With uv

uv run amqcsl make scripts/test.py

Running the script¶

There should now be a test.py file sitting in the scripts directory. To run it:

Normal

python3 -m scripts.test

With uv

uv run -m scripts.test

You should see something like:

[2025-06-02 23:43:35,859|amqcsl.client]:INFO: Retrieving session cookie
[2025-06-02 23:43:35,860|amqcsl.client]:INFO: Creating client
[2025-06-02 23:43:35,893|amqcsl.client]:INFO: Verifying permissions
[2025-06-02 23:43:35,893|amqcsl.client]:INFO: Invalid session cookie, attempting login
[2025-06-02 23:43:37,833|httpx]:INFO: HTTP Request: POST https://amqbot.082640.xyz/api/login "HTTP/1.1 200 OK"
[2025-06-02 23:43:37,833|amqcsl.client]:INFO: Writing session_id to amq_session.txt
[2025-06-02 23:43:38,181|httpx]:INFO: HTTP Request: GET https://amqbot.082640.xyz/api/auth/me "HTTP/1.1 200 OK"
[2025-06-02 23:43:38,183|amqcsl.client]:INFO: Auth successful
[2025-06-02 23:43:38,183|__main__]:INFO: shiHib
[2025-06-02 23:43:38,183|amqcsl.client]:INFO: Closing client

If you run into any issues, double check your username and password in scripts/.env. The next time you run a script, it should automatically detect the session cookie in amq_session.txt and skip the login.

Next Steps¶

You’re all set up! 🎉

Now head over to the Quickstart guide to learn how to use the library. Note that in the docs, the CLI commands are prefixed by just amqcsl, but you should be doing python3 -m amqcsl or uv run amqcsl.