kerykeion 4.11.0__tar.gz → 4.11.1__tar.gz

{kerykeion-4.11.0 → kerykeion-4.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kerykeion
-Version: 4.11.0
+Version: 4.11.1
 Summary: A python library for astrology.
 Home-page: https://github.com/g-battaglia/kerykeion
 License: AGPL-3.0
@@ -69,13 +69,13 @@ The core goal of this project is to provide a simple and easy approach to astrol
 
 Here's an example of a birthchart:
 
-![Kanye Birth Chart](http://centuryboy.altervista.org/KanyeNatalChart.svg)
+![Kanye Birth Chart](https://www.kerykeion.net/assets/img/examples/birth-chart.svg)
 
 ## Web API
 
 If you want to use Kerykeion in a web application, I've created a web API for this purpose, you can find it here:
 
-**[AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/)**
+**[AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/pricing)**
 
 It's [open source](https://github.com/g-battaglia/Astrologer-API), it's a way to support me and the project.
 
@@ -142,24 +142,30 @@ If you omit the nation, it will be set to "GB" by default, but the value is not
 ```python
 from kerykeion import AstrologicalSubject, KerykeionChartSVG
 
-first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 10, 30, "Liverpool", "GB")
+second = AstrologicalSubject("Paul McCartney", 1942, 6, 18, 15, 30, "Liverpool", "GB")
 
 # Set the type, it can be Natal, Synastry or Transit
+synastry_chart = KerykeionChartSVG(first, "Synastry", second)
+synastry_chart.makeSVG()
 
-name = KerykeionChartSVG(first, chart_type="Synastry", second_obj=second)
-name.makeSVG()
-print(len(name.aspects_list))
+```
 
-#> Generating kerykeion object for Jack...
-#> Generating kerykeion object for Jane...
-#> Jack birth location: Roma, 41.89193, 12.51133
-#> SVG Generated Correctly
-#> 38
+![John Lennon and Paul McCartney Synastry](https://www.kerykeion.net/assets/img/examples/synastry-chart.svg)
 
-```
 
-![Synastry Chart](http://centuryboy.altervista.org/JackComposite_Chart.svg)
+Note: By default, the generated SVG file will be in the home directory! To change the destination directory:
+
+```python
+from kerykeion import AstrologicalSubject, KerykeionChartSVG
+
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 10, 30, "Liverpool", "GB")
+second = AstrologicalSubject("Paul McCartney", 1942, 6, 18, 15, 30, "Liverpool", "GB")
+
+# Synastry Chart
+synastry_chart = KerykeionChartSVG(first, "Synastry", second, new_output_directory=".")
+synastry_chart.makeSVG()
+```
 
 ## Report
 
@@ -264,7 +270,7 @@ You can set the houses system in the AstrologicalSubject class:
 johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", houses_system="M")
 ```
 
-More examples [here](https://www.kerykeion.net/docs/examples/house-systems/).
+More examples [here](https://www.kerykeion.net/docs/examples/houses-systems/).
 
 Full list of supported house systems [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#HousesSystem).
 

{kerykeion-4.11.0 → kerykeion-4.11.1}/README.md

@@ -32,13 +32,13 @@ The core goal of this project is to provide a simple and easy approach to astrol
 
 Here's an example of a birthchart:
 
-![Kanye Birth Chart](http://centuryboy.altervista.org/KanyeNatalChart.svg)
+![Kanye Birth Chart](https://www.kerykeion.net/assets/img/examples/birth-chart.svg)
 
 ## Web API
 
 If you want to use Kerykeion in a web application, I've created a web API for this purpose, you can find it here:
 
-**[AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/)**
+**[AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/pricing)**
 
 It's [open source](https://github.com/g-battaglia/Astrologer-API), it's a way to support me and the project.
 
@@ -105,24 +105,30 @@ If you omit the nation, it will be set to "GB" by default, but the value is not
 ```python
 from kerykeion import AstrologicalSubject, KerykeionChartSVG
 
-first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 10, 30, "Liverpool", "GB")
+second = AstrologicalSubject("Paul McCartney", 1942, 6, 18, 15, 30, "Liverpool", "GB")
 
 # Set the type, it can be Natal, Synastry or Transit
+synastry_chart = KerykeionChartSVG(first, "Synastry", second)
+synastry_chart.makeSVG()
 
-name = KerykeionChartSVG(first, chart_type="Synastry", second_obj=second)
-name.makeSVG()
-print(len(name.aspects_list))
+```
 
-#> Generating kerykeion object for Jack...
-#> Generating kerykeion object for Jane...
-#> Jack birth location: Roma, 41.89193, 12.51133
-#> SVG Generated Correctly
-#> 38
+![John Lennon and Paul McCartney Synastry](https://www.kerykeion.net/assets/img/examples/synastry-chart.svg)
 
-```
 
-![Synastry Chart](http://centuryboy.altervista.org/JackComposite_Chart.svg)
+Note: By default, the generated SVG file will be in the home directory! To change the destination directory:
+
+```python
+from kerykeion import AstrologicalSubject, KerykeionChartSVG
+
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 10, 30, "Liverpool", "GB")
+second = AstrologicalSubject("Paul McCartney", 1942, 6, 18, 15, 30, "Liverpool", "GB")
+
+# Synastry Chart
+synastry_chart = KerykeionChartSVG(first, "Synastry", second, new_output_directory=".")
+synastry_chart.makeSVG()
+```
 
 ## Report
 
@@ -227,7 +233,7 @@ You can set the houses system in the AstrologicalSubject class:
 johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", houses_system="M")
 ```
 
-More examples [here](https://www.kerykeion.net/docs/examples/house-systems/).
+More examples [here](https://www.kerykeion.net/docs/examples/houses-systems/).
 
 Full list of supported house systems [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#HousesSystem).
 

kerykeion-4.11.1/kerykeion/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+"""
+This is part of Kerykeion (C) 2024 Giacomo Battaglia
+
+.. include:: ../README.md
+"""
+
+# Local
+from .astrological_subject import AstrologicalSubject
+from .charts.kerykeion_chart_svg import KerykeionChartSVG
+from .kr_types import *
+from .relationship_score import RelationshipScore
+from .aspects import SynastryAspects, NatalAspects
+from .report import Report
+from .settings import KerykeionSettingsModel, get_settings
+from .enums import Planets, Aspects, Signs

{kerykeion-4.11.0 → kerykeion-4.11.1}/kerykeion/aspects/aspects_utils.py

@@ -23,7 +23,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     if int(distance) <= aspects_settings[0]["orb"]:
         name = aspects_settings[0]["name"]
         aspect_degrees = aspects_settings[0]["degree"]
-        color = aspects_settings[0]["color"]
         verdict = True
         aid = 0
 
@@ -34,7 +33,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[1]["name"]
         aspect_degrees = aspects_settings[1]["degree"]
-        color = aspects_settings[1]["color"]
         verdict = True
         aid = 1
 
@@ -45,7 +43,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[2]["name"]
         aspect_degrees = aspects_settings[2]["degree"]
-        color = aspects_settings[2]["color"]
         verdict = True
         aid = 2
 
@@ -56,7 +53,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[3]["name"]
         aspect_degrees = aspects_settings[3]["degree"]
-        color = aspects_settings[3]["color"]
         verdict = True
         aid = 3
 
@@ -67,7 +63,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[4]["name"]
         aspect_degrees = aspects_settings[4]["degree"]
-        color = aspects_settings[4]["color"]
         verdict = True
         aid = 4
 
@@ -78,7 +73,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[5]["name"]
         aspect_degrees = aspects_settings[5]["degree"]
-        color = aspects_settings[5]["color"]
         verdict = True
         aid = 5
 
@@ -89,7 +83,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[6]["name"]
         aspect_degrees = aspects_settings[6]["degree"]
-        color = aspects_settings[6]["color"]
         verdict = True
         aid = 6
 
@@ -100,7 +93,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[7]["name"]
         aspect_degrees = aspects_settings[7]["degree"]
-        color = aspects_settings[7]["color"]
         verdict = True
         aid = 7
 
@@ -111,7 +103,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[8]["name"]
         aspect_degrees = aspects_settings[8]["degree"]
-        color = aspects_settings[8]["color"]
         verdict = True
         aid = 8
 
@@ -122,7 +113,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[9]["name"]
         aspect_degrees = aspects_settings[9]["degree"]
-        color = aspects_settings[9]["color"]
         verdict = True
         aid = 9
 
@@ -133,7 +123,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
     ):
         name = aspects_settings[10]["name"]
         aspect_degrees = aspects_settings[10]["degree"]
-        color = aspects_settings[10]["color"]
         verdict = True
         aid = 10
 
@@ -150,7 +139,6 @@ def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, i
         name,
         distance - aspect_degrees,
         aspect_degrees,
-        color,
         aid,
         diff,
     )

{kerykeion-4.11.0 → kerykeion-4.11.1}/kerykeion/aspects/natal_aspects.py

@@ -52,7 +52,7 @@ class NatalAspects:
         for first in range(len(active_points_list)):
             # Generates the aspects list without repetitions
             for second in range(first + 1, len(active_points_list)):
-                verdict, name, orbit, aspect_degrees, color, aid, diff = get_aspect_from_two_points(
+                verdict, name, orbit, aspect_degrees, aid, diff = get_aspect_from_two_points(
                     self.aspects_settings, active_points_list[first]["abs_pos"], active_points_list[second]["abs_pos"]
                 )
 
@@ -65,7 +65,6 @@ class NatalAspects:
                         "aspect": name,
                         "orbit": orbit,
                         "aspect_degrees": aspect_degrees,
-                        "color": color,
                         "aid": aid,
                         "diff": diff,
                         "p1": planet_id_decoder(self.celestial_points, active_points_list[first]["name"]),

{kerykeion-4.11.0 → kerykeion-4.11.1}/kerykeion/aspects/synastry_aspects.py

@@ -60,7 +60,7 @@ class SynastryAspects(NatalAspects):
         for first in range(len(first_active_points_list)):
             # Generates the aspects list whitout repetitions
             for second in range(len(second_active_points_list)):
-                verdict, name, orbit, aspect_degrees, color, aid, diff = get_aspect_from_two_points(
+                verdict, name, orbit, aspect_degrees, aid, diff = get_aspect_from_two_points(
                     self.aspects_settings,
                     first_active_points_list[first]["abs_pos"],
                     second_active_points_list[second]["abs_pos"],
@@ -75,7 +75,6 @@ class SynastryAspects(NatalAspects):
                         "aspect": name,
                         "orbit": orbit,
                         "aspect_degrees": aspect_degrees,
-                        "color": color,
                         "aid": aid,
                         "diff": diff,
                         "p1": planet_id_decoder(

{kerykeion-4.11.0 → kerykeion-4.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kerykeion"
-version = "4.11.0"
+version = "4.11.1"
 authors = ["Giacomo Battaglia <battaglia.giacomo@yahoo.it>"]
 description = "A python library for astrology."
 license = "AGPL-3.0"

kerykeion-4.11.0/kerykeion/__init__.py

@@ -1,257 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-<h1 align=center>Kerykeion</h1>
-<div align="center">
-    <a href="#">
-        <img src="https://img.shields.io/github/contributors/g-battaglia/kerykeion?color=blue&logo=github" alt="contributors">
-    </a>
-    <a href="#">
-        <img src="https://img.shields.io/github/stars/g-battaglia/kerykeion.svg?logo=github" alt="stars">
-    </a>
-    <a href="#">
-        <img src="https://img.shields.io/github/forks/g-battaglia/kerykeion.svg?logo=github" alt="forks">
-    </a>
-    <a href="https://pypi.org/project/kerykeion" target="_blank">
-        <img src="https://visitor-badge.laobi.icu/badge?page_id=g-battaglia.kerykeion" alt="visitors"/>
-    </a>
-    <a href="https://pypi.org/project/kerykeion" target="_blank">
-        <img src="https://img.shields.io/pypi/v/kerykeion?label=pypi%20package" alt="Package version">
-    </a>
-    <a href="https://pypi.org/project/kerykeion" target="_blank">
-        <img src="https://img.shields.io/pypi/pyversions/kerykeion.svg" alt="Supported Python versions">
-    </a>
-</div>
-
-&nbsp;
-
-Kerykeion is a python library for Astrology.
-It can calculate all the planet and house position,
-also it can calculate the aspects of a single persone or between two, you can set how many planets you
-need in the settings in the utility module.
-It also can generate an SVG of a birthchart, a synastry chart or a transit chart.
-
-The core goal of this project is to provide a simple and easy approach to astrology in a data driven way.
-
-Here's an example of a birthchart:
-
-![Kanye Birth Chart](http://centuryboy.altervista.org/KanyeNatalChart.svg)
-
-## Web API
-
-If you want to use Kerykeion in a web application, I've created a web API for this purpose, you can find it here:
-
-**[AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/)**
-
-It's [open source](https://github.com/g-battaglia/Astrologer-API), it's a way to support me and the project.
-
-## Donate
-
-Maintaining this project is a lot of work, the Astrologer API doesn't nearly cover the costs of a software engineer working on this project full time. I do this because I love it, but until I can make this my full time job, I won't be able to spend as much time on it.
-
-If you want to support me, you can do it here:
-
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/kerykeion)
-
-## Installation
-
-Kerykeion is a _Python 3.9_ package, make sure you have _Python 3.9_ or above installed on your system.
-
-```bash
-pip3 install kerykeion
-```
-
-## Usage
-
-Here some examples:
-
-```python
-
-# Import the main class for creating a kerykeion instance:
-from kerykeion import AstrologicalSubject
-
-# Create a kerykeion instance:
-# Args: Name, year, month, day, hour, minuts, city, nation(optional)
-kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
-
-# Get the information about the sun in the chart:
-# (The position of the planets always starts at 0)
-kanye.sun
-
-#> {'name': 'Sun', 'quality': 'Mutable', 'element': 'Air', 'sign': 'Gem', 'sign_num': 2, 'pos': 17.598992059774275, 'abs_pos': 77.59899205977428, 'emoji': '♊️', 'house': '12th House', 'retrograde': False}
-
-# Get information about the first house:
-kanye.first_house
-
-#> {'name': 'First_House', 'quality': 'Cardinal', 'element': 'Water', 'sign': 'Can', 'sign_num': 3, 'pos': 17.995779673209114, 'abs_pos': 107.99577967320911, 'emoji': '♋️'}
-
-# Get element of the moon sign:
-kanye.moon.element
-
-#> 'Water'
-
-```
-
-**To avoid connecting to GeoNames (eg. avoiding hourly limit or no internet connection) you should instance kerykeion like this:**
-
-```python
-kanye = AstrologicalSubject(
-    "Kanye", 1977, 6, 8, 8, 45, lng=50, lat=50, tz_str="Europe/Rome", city="Rome"
-)
-```
-
-The difference is that you have to pass the longitude, latitude and the timezone string, instead of the city and nation.
-If you omit the nation, it will be set to "GB" by default, but the value is not used for calculations. It's better to set it to the correct value though.
-
-## Generate a SVG Chart
-
-```python
-from kerykeion import AstrologicalSubject, KerykeionChartSVG
-
-first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
-
-# Set the type, it can be Natal, Synastry or Transit
-
-name = KerykeionChartSVG(first, chart_type="Synastry", second_obj=second)
-name.makeSVG()
-print(len(name.aspects_list))
-
-#> Generating kerykeion object for Jack...
-#> Generating kerykeion object for Jane...
-#> Jack birth location: Roma, 41.89193, 12.51133
-#> SVG Generated Correctly
-#> 38
-
-```
-
-![Synastry Chart](http://centuryboy.altervista.org/JackComposite_Chart.svg)
-
-## Report
-
-To print a report of all the data:
-
-```python
-from kerykeion import Report, AstrologicalSubject
-
-kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
-report = Report(kanye)
-report.print_report()
-
-```
-
-Returns:
-
-```bash
-+- Kerykeion report for Kanye -+
-+----------+------+-------------+-----------+----------+
-| Date     | Time | Location    | Longitude | Latitude |
-+----------+------+-------------+-----------+----------+
-| 8/6/1977 | 8:45 | Atlanta, US | -84.38798 | 33.749   |
-+----------+------+-------------+-----------+----------+
-+-----------+------+-------+------+----------------+
-| Planet    | Sign | Pos.  | Ret. | House          |
-+-----------+------+-------+------+----------------+
-| Sun       | Gem  | 17.6  | -    | Twelfth_House  |
-| Moon      | Pis  | 16.43 | -    | Ninth_House    |
-| Mercury   | Tau  | 26.29 | -    | Eleventh_House |
-| Venus     | Tau  | 2.03  | -    | Tenth_House    |
-| Mars      | Tau  | 1.79  | -    | Tenth_House    |
-| Jupiter   | Gem  | 14.61 | -    | Eleventh_House |
-| Saturn    | Leo  | 12.8  | -    | Second_House   |
-| Uranus    | Sco  | 8.27  | R    | Fourth_House   |
-| Neptune   | Sag  | 14.69 | R    | Fifth_House    |
-| Pluto     | Lib  | 11.45 | R    | Fourth_House   |
-| Mean_Node | Lib  | 21.49 | R    | Fourth_House   |
-| True_Node | Lib  | 22.82 | R    | Fourth_House   |
-| Chiron    | Tau  | 4.17  | -    | Tenth_House    |
-+-----------+------+-------+------+----------------+
-+----------------+------+----------+
-| House          | Sign | Position |
-+----------------+------+----------+
-| First_House    | Can  | 18.0     |
-| Second_House   | Leo  | 9.51     |
-| Third_House    | Vir  | 4.02     |
-| Fourth_House   | Lib  | 3.98     |
-| Fifth_House    | Sco  | 9.39     |
-| Sixth_House    | Sag  | 15.68    |
-| Seventh_House  | Cap  | 18.0     |
-| Eighth_House   | Aqu  | 9.51     |
-| Ninth_House    | Pis  | 4.02     |
-| Tenth_House    | Ari  | 3.98     |
-| Eleventh_House | Tau  | 9.39     |
-| Twelfth_House  | Gem  | 15.68    |
-+----------------+------+----------+
-
-```
-
-And if you want to export it to a file:
-
-```bash
-python3 your_script_name.py > file.txt
-```
-
-## Other exeples of possibles usecase
-
-```python
-# Get all aspects between two persons:
-
-from kerykeion import SynastryAspects, AstrologicalSubject
-first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
-
-name = SynastryAspects(first, second)
-aspect_list = name.get_relevant_aspects()
-print(aspect_list[0])
-
-#> Generating kerykeion object for Jack...
-#> Generating kerykeion object for Jane...
-#> {'p1_name': 'Sun', 'p1_abs_pos': 84.17867971515636, 'p2_name': 'Sun', 'p2_abs_pos': 211.90472999502984, 'aspect': 'trine', 'orbit': 7.726050279873476, 'aspect_degrees': 120, 'color': '#36d100', 'aid': 6, 'diff': 127.72605027987348, 'p1': 0, 'p2': 0}
-
-```
-
-## Ayanamsa (Sidereal Modes)
-
-You can set the zodiac type and the sidereal mode in the AstrologicalSubject class:
-
-```python
-johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", zodiac_type="Sidereal", sidereal_mode="LAHIRI")
-```
-
-More examples [here](https://www.kerykeion.net/docs/examples/sidereal-modes/).
-
-Full list of supported sidereal modes [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#SiderealMode).
-
-## Documentation
-
-Most of the functions and the classes are self documented by the types and have docstrings.
-An auto-generated documentation [is available here](https://www.kerykeion.net/pydocs/kerykeion.html).
-
-Sooner or later I'll try to write an extensive documentation.
-
-## Development
-
-You can clone this repository or download a zip file using the right side buttons.
-
-## Contributing
-
-Feel free to contribute to the code!
-
-## License
-
-This project is licensed under the AGPL-3.0 License.
-To understand how this impacts your use of the software, please see the [LICENSE](LICENSE) file for details.
-If you have questions, you can reach out to me at my [email](mailto:battaglia.giacomo@yahoo.it?subject=Kerykeion) address.
-As a rule of thumb, if you are using this library in a project, you should open source the code of the project with a compatible license.
-
-You can implement the logic of kerykeion in your project and also keep it closed source by using a third party API, like the [AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/). The AstrologerAPI is AGPL-3.0 compliant. Subscribing to the API is also, currently, the best way to support the project.
-"""
-
-# Local
-from .astrological_subject import AstrologicalSubject
-from .charts.kerykeion_chart_svg import KerykeionChartSVG
-from .kr_types import *
-from .relationship_score import RelationshipScore
-from .aspects import SynastryAspects, NatalAspects
-from .report import Report
-from .settings import KerykeionSettingsModel, get_settings
-from .enums import Planets, Aspects, Signs