Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.2.3 instead.

astromansion

Official Python client for the AstroMansion astrology API.

Nothing is computed locally. Every call reaches https://api.astromansion.com, which owns the ephemeris, your plan, your quota and your rate limit. The package never opens a feature the server did not grant.

Install

pip install astromansion

Python 3.10 or newer. The only dependency is httpx, installed with its SOCKS support so the client still works behind a corporate proxy, a local SOCKS proxy or Tor without anything further to install.

Get an API key

Create an account at astromansion.com, open your account page and generate a key. Requests made with it count against that account, under the plan it already has.

First chart

Put the key in the environment rather than in your source:

export ASTROMANSION_API_KEY="your key"
from astromansion import AstroMansion

client = AstroMansion()

chart = client.natal(
    date="1990-07-19",
    time="14:30",
    lat=41.0082,
    lon=28.9784,
    timezone=3,
)

print(chart.summary.Sun.sign)  # Cancer
print(chart.planets[0].house)  # 9

Birth data is passed flat. The API nests it under birth; the client does that for you.

Fields: date as YYYY-MM-DD, time as HH:MM (omit if unknown), lat and lon in decimal degrees, timezone as an hour offset or an IANA zone name, houses for a house system.

You can pass a mapping instead of keywords, but not both at once:

chart = client.natal({"date": "1990-07-19", "lat": 41.0082, "lon": 28.9784})

Where the key comes from

In order: the api_key argument, then astromansion.set_api_key(...), then ASTROMANSION_API_KEY. With none of them the constructor raises AuthenticationError, before a connection is opened and before the proxy environment is read, so a forgotten key is reported as a forgotten key.

client = AstroMansion(api_key="your key")

astromansion.reset() drops the module key and the shared client, which is what a test wants between cases.

Quick use

For a notebook or a one-file script:

import astromansion as am

am.set_api_key("your key")  # or rely on the environment
chart = am.natal(date="1990-07-19", lat=41.0082, lon=28.9784)

Applications should build a client instead: it holds a connection pool, and two of them can carry two different keys.

Async

from astromansion import AsyncAstroMansion

async with AsyncAstroMansion() as client:
    chart = await client.natal(
        date="1990-07-19",
        time="14:30",
        lat=41.0082,
        lon=28.9784,
        timezone=3,
    )

Same method names, same arguments, same exceptions. Python cannot make one class serve both, so the bare name is synchronous and Async marks the other, as in httpx, openai and anthropic.

Reading a response

The response is the server's own JSON, readable either way:

chart.summary.Sun.sign
chart["summary"]["Sun"]["sign"]
chart.to_dict()

Nothing is remodelled, so a field the API adds reaches you instead of being dropped, and no field it did not send is invented.

Some endpoints answer with the data itself and some wrap it as {"technique": ..., "result": ...}. The client opens that wrapper, so every response reads the same way and you never have to remember which kind you called:

chart = client.vedic_chart(date="1990-07-19", lat=41.0082, lon=28.9784)

chart.data          # the payload, wrapper removed
chart.technique     # what the server called it, when it said
chart.raw           # the untouched body, wrapper included

A body that carries a real result field of its own is left alone; the wrapper is recognised by its exact shape rather than by the presence of a name that data is allowed to use.

Arabic lots, fixed stars and the rest of the catalog

natal answers with the chart proper. Anything beyond it is named on chart, through options.categories:

lots = client.chart(
    date="1990-07-19", time="14:30",
    lat=41.0082, lon=28.9784, timezone=3,
    options={"categories": ["arabic_lots"]},
)

for lot in lots.data["bodies"]["arabic_lots"]:
    print(lot["name"], lot["sign"], lot["dms"], lot["house"])

Bodies come back grouped under the category that produced them, so read the group you asked for. The catalog publishes 34 Arabic lots and 890 fixed stars, along with planets, dwarfs, asteroids, centaurs, comets, hypotheticals, points, advanced_points, lilith, planetary_nodes, exoplanets, moons and eclipses.

chart answers one page at a time, and a large category is more than one page. Use bodies to read the whole of it and let the client follow the paging:

found = client.bodies(
    "fixed_stars", "arabic_lots",
    date="1990-07-19", time="14:30",
    lat=41.0082, lon=28.9784, timezone=3,
)

len(found["fixed_stars"])  # 890, in six requests
len(found["arabic_lots"])  # 34

Naming several categories reads them in one walk. The return is always a mapping keyed by the categories you asked for, one or several, so the shape never depends on how many.

Each page costs a network round trip and the calculation inside it is a rounding error beside that, so bodies asks for the largest page the API serves. page_size lowers it, and lowering it buys nothing: 890 stars are six requests at 160 and a hundred and eighty at five.

Reach for chart directly when you want one page rather than the category, and read the group with .get. The chart's own bodies are calculated alongside the categories you name and the page is a window over that whole selection, so a small catalog_limit can fill the first page with planets and angles before a single star appears, leaving no fixed_stars key at all. catalog_page.total counts the same way, the whole selection rather than the category.

There is no ceiling on how many you may read this way. options.all_bodies walks every category at once and needs the full-catalog scope that comes with Pro and Enterprise; naming the categories yourself does not.

Every endpoint

Every published operation, 66 of them, has a method on both clients and a module-level shortcut, all generated from the schema: natal, transits, synastry, composite, solar_return, progression, harmonics, astrocartography, vedic_chart, zodiacal_releasing, firdaria, horary, electional and the rest.

Anything new is reachable before this client names it:

result = client.request("POST", "/v1/harmonics", json={"birth": {...}})

Authentication, timeouts, retries and error handling behave identically there.

Errors

from astromansion import QuotaExceededError, RateLimitError

try:
    chart = client.natal(date="1990-07-19", lat=41.0, lon=29.0)
except RateLimitError as error:
    print("wait", error.retry_after, "seconds")
except QuotaExceededError:
    print("this period's allowance is spent")
Exception Meaning
AuthenticationError Key missing, malformed or unknown
PermissionDeniedError Valid key, feature not in the plan
QuotaExceededError Allowance for the period is spent
RateLimitError Too many requests just now; retry_after says how long
ValidationError Request rejected; details names the field
NotFoundError, ConflictError Missing resource, conflicting state
ServerError The API failed to answer
AstroMansionConnectionError The request never completed

All descend from AstroMansionError. Each carries status_code, error_code, details, request_id and retry_after when the API supplies them.

Rate limits and quota

A rate limit clears on its own after retry_after. A spent quota does not: it needs a new period or a larger plan. They are separate exceptions for that reason.

The client retries only failures that carry no result: connection errors, 429 and 5xx, twice by default, honouring Retry-After. A refusal you must fix is never retried.

client = AstroMansion(timeout=60.0, max_retries=0)

Documents

pdf = client.export_pdf(date="1990-07-19", lat=41.0082, lon=28.9784)

with open("chart.pdf", "wb") as file:
    file.write(pdf)

Or name a path and let the client write it:

client.export_pdf(date="1990-07-19", lat=41.0082, lon=28.9784, output="chart.pdf")

Every endpoint that answers with a document takes output the same way: export_pdf, export_csv, render_svg, render_png, render_biwheel and render_sharecard, on both clients.

client.render_svg(date="1990-07-19", lat=41.0082, lon=28.9784, output="wheel.svg")

Nothing is written to disk unless you name a path, so a call cannot overwrite a file you did not choose. Without one you get the bytes and decide yourself.

Security

The key travels in the X-API-Key header, never in a URL. It is masked in repr(client) and appears in no exception or log line the package writes. Keep it in the environment or a secret store, not in source control. Rotate it from your account page if it leaks.

Staging

client = AstroMansion(base_url="http://localhost:8000")

Also readable from ASTROMANSION_BASE_URL.

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astromansion-0.1.5.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astromansion-0.1.5-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

Details for the file astromansion-0.1.5.tar.gz.

File metadata

  • Download URL: astromansion-0.1.5.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for astromansion-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b920b9f5cfbbf62bba65e09e7d3cb63f097327a2663bbf5ce8b2390c1190d39e
MD5 675b73e362154a32f9ce0677257b0382
BLAKE2b-256 cbaf98d7c84e40f13da62438d972b8af46fdb01421ed72970329a671a92011b3

See more details on using hashes here.

File details

Details for the file astromansion-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: astromansion-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 42.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for astromansion-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 84d385129cae06238cae8a0a2f7d57bbd1bc476703b80792f2085e962a912cc6
MD5 77499d3e8c9dd4a606361f8b72f4a8c6
BLAKE2b-256 5307a899d6abeef8c7f55fac08b32921c361420c83d5c6fc7e76392cba702201

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

This release

0.1.5 This release

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page