kerykeion 4.8.1__py3-none-any.whl → 4.12.3__py3-none-any.whl

{kerykeion-4.8.1.dist-info → kerykeion-4.12.3.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: kerykeion
-Version: 4.8.1
+Version: 4.12.3
 Summary: A python library for astrology.
-Home-page: https://github.com/g-battaglia/kerykeion
+Home-page: https://www.kerykeion.net/
 License: AGPL-3.0
 Keywords: astrology,ephemeris,astrology library,birtchart,svg,zodiac,zodiac-sing,astronomical-algorithms,synastry,astrology-calculator
 Author: Giacomo Battaglia
@@ -28,8 +28,8 @@ Classifier: Typing :: Typed
 Requires-Dist: pydantic (>=2.5,<3.0)
 Requires-Dist: pyswisseph (>=2.10.3.1,<3.0.0.0)
 Requires-Dist: pytz (>=2022.7,<2023.0)
-Requires-Dist: requests (>=2.28.1,<3.0.0)
-Requires-Dist: requests-cache (>=0.9.7,<0.10.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: requests-cache (>=1.2.1,<2.0.0)
 Requires-Dist: scour (>=0.38.2,<0.39.0)
 Requires-Dist: terminaltables (>=3.1.10,<4.0.0)
 Project-URL: Repository, https://github.com/g-battaglia/kerykeion
@@ -48,7 +48,7 @@ Description-Content-Type: text/markdown
     </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>
     <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>
@@ -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.
 
@@ -95,9 +95,11 @@ Kerykeion is a _Python 3.9_ package, make sure you have _Python 3.9_ or above in
 pip3 install kerykeion
 ```
 
-## Usage
+## Basic Usage
+
+The basic usage of the library is to create an instance of the AstrologicalSubject class and then access the properties of the instance to get the astrological information about the subject.
 
-Here some examples:
+Here's an example:
 
 ```python
 
@@ -105,8 +107,8 @@ Here some examples:
 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")
+# Args: Name, year, month, day, hour, minuts, city, nation
+kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta", "US")
 
 # Get the information about the sun in the chart:
 # (The position of the planets always starts at 0)
@@ -137,38 +139,68 @@ kanye = AstrologicalSubject(
 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:
+## Generate a SVG Chart
+
+### Birth 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")
+
+birth_chart = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta", "US")
+birth_chart_svg = KerykeionChartSVG(birth_chart)
+
+birth_chart_svg.makeSVG()
+```
+
+The SVG file will be saved in the home directory.
+![John Lennon Birth Chart](https://www.kerykeion.net/assets/img/examples/birth-chart.svg)
+
+### Synastry Chart
+
+```python
+from kerykeion import AstrologicalSubject, KerykeionChartSVG
+
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 18, 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)
 
+### Change the output directory
+
+By default the output directory is the home directory, you can change it by passing the new_output_directory parameter to the KerykeionChartSVG class:
+
+```python
+from kerykeion import AstrologicalSubject, KerykeionChartSVG
+
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 18, 30, "Liverpool", "GB")
+second = AstrologicalSubject("Paul McCartney", 1942, 6, 18, 15, 30, "Liverpool", "GB")
+
+# Set the output directory to the current directory
+synastry_chart = KerykeionChartSVG(first, "Synastry", second, new_output_directory=".")
+synastry_chart.makeSVG()
 ```
 
-![Synastry Chart](http://centuryboy.altervista.org/JackComposite_Chart.svg)
+### Change Language
+
+To change the language of the chart you should create a new kr.config.js file and pass it to the BirthChartSVG class. So far the available languages are English, Portuguese, Italian, Spanish, French and Chinese.
 
-# Report
+Some examples [here](https://www.kerykeion.net/docs/examples/change-language).
+
+## Report
 
 To print a report of all the data:
 
 ```python
 from kerykeion import Report, AstrologicalSubject
 
-kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
+kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta", "US")
 report = Report(kanye)
 report.print_report()
 
@@ -176,7 +208,7 @@ report.print_report()
 
 Returns:
 
-```
+```txt
 +- Kerykeion report for Kanye -+
 +----------+------+-------------+-----------+----------+
 | Date     | Time | Location    | Longitude | Latitude |
@@ -222,17 +254,17 @@ Returns:
 And if you want to export it to a file:
 
 ```bash
-$ python3 your_script_name.py > file.txt
+python3 your_script_name.py > file.txt
 ```
 
-## Other exeples of possibles usecase
+## Other examples of possible use cases:
 
 ```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")
+first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma", "IT")
+second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma", "IT")
 
 name = SynastryAspects(first, second)
 aspect_list = name.get_relevant_aspects()
@@ -244,10 +276,74 @@ print(aspect_list[0])
 
 ```
 
+## Ayanamsa (Sidereal Modes)
+
+By default, the zodiac type is set to Tropic (Tropical).
+You can set the zodiac type to Sidereal 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).
+
+## Houses Systems
+
+By default, the houses system is set to Placidus.
+You can set the houses system in the AstrologicalSubject class:
+
+```python
+johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", houses_system="M")
+```
+
+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).
+
+So far all the available houses system in the Swiss Ephemeris are supported but the Gauquelin Sectors.
+
+## Perspective Type
+
+By default, the perspective type is set to Apparent Geocentric (the most common standard for astrology).
+The perspective indicates the point of view from which the chart is calculated (Es. Apparent Geocentric, Heliocentric, etc.).
+You can set the perspective type in the AstrologicalSubject class:
+
+```python
+johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", perspective_type="Heliocentric")
+```
+
+More examples [here](https://www.kerykeion.net/docs/examples/perspective-type/).
+
+Full list of supported perspective types [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#PerspectiveType).
+
+## Alternative Initialization
+
+You can initialize the AstrologicalSubject from a **UTC** ISO 8601 string:
+
+```python
+subject = AstrologicalSubject.get_from_iso_utc_time(
+    "Johnny Depp", "1963-06-09T05:00:00Z", "Owensboro", "US")
+```
+
+Note : The default time zone is UTC, with Greenwich longitude and latitude.
+
+The default online/offline mode is set to offline, if you set it online the default latitude and longitude will be ignored and
+calculated from the city and nation. Remember to pass also the geonames_username parameter if you want to use the online mode, like this:
+
+```python
+from kerykeion.astrological_subject import AstrologicalSubject
+
+# Use the static method get_from_iso_utc_time to create an instance of AstrologicalSubject
+subject = AstrologicalSubject.get_from_iso_utc_time(
+    "Johnny Depp", "1963-06-09T05:00:00Z", "Owensboro", "US", online=True)
+```
+
 ## 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://g-battaglia.github.io/kerykeion).
+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.
 
@@ -266,5 +362,5 @@ To understand how this impacts your use of the software, please see the [LICENSE
 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 kerkeion 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.
+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.
 

kerykeion-4.12.3.dist-info/RECORD

@@ -0,0 +1,32 @@
+LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
+kerykeion/__init__.py,sha256=AOTx2pvk1-SByVSen5VW4QHsN5LTIjNxpHOIjlm8XA4,487
+kerykeion/aspects/__init__.py,sha256=9FlDVI1ndCJga0-chNIhcLitjU_x3kbtAFfFqVp2ejc,293
+kerykeion/aspects/aspects_utils.py,sha256=ZCOnhgW6CZQrCruAGaf8vkUlBtjubbfKOqXy6qyQupE,5321
+kerykeion/aspects/natal_aspects.py,sha256=R47UToYKqbVrRmGzmY4pgsikcoXNmJvs5KhSmz7HZtM,4460
+kerykeion/aspects/synastry_aspects.py,sha256=BqG0E4tDZJjPQm3NTX3G6LkTuijP0AsKtI9pwH0F_Mc,3946
+kerykeion/astrological_subject.py,sha256=skJW8Xey_cyews-3CRusO_9jDTKTiOFOIWoeX5t0hHA,32781
+kerykeion/charts/__init__.py,sha256=Juxkduy2TaagWblh_7CE8Acrg3dHL27-WEddJhau_eQ,127
+kerykeion/charts/charts_utils.py,sha256=Pfy-SkPnABIy5ZkKgypnGqxXOAKhTRIeQX3fQKO8DgQ,15065
+kerykeion/charts/kerykeion_chart_svg.py,sha256=P3xRWedqdbYjeI1xX9saL729IXBfJ_8TWLz1AzUF5vI,64864
+kerykeion/charts/templates/chart.xml,sha256=aP_dVC2w2sULBtGrjrOUi46e5m59zKaMizMnTq1VfNM,67714
+kerykeion/enums.py,sha256=Ben9GLYkPucpYY2ZDpURzUbNCc9jzK2MuaffkgiXFdQ,965
+kerykeion/fetch_geonames.py,sha256=ZWB1DbcH54ab3fQhzPhLY0Dz0OaPJqiHFn2e7DRr1MM,4588
+kerykeion/kr_types/__init__.py,sha256=-qhGQikurdoHnGtuT1bsaEeZ-IwmZtIHMjGOPC9_oqQ,295
+kerykeion/kr_types/chart_types.py,sha256=qaZjm1rMpDDnUZlLjEihd9KPyv3PvrV8vkRmNBuRZzE,2201
+kerykeion/kr_types/kerykeion_exception.py,sha256=G-7VFta78qBt10l54JZWvwH-3lUNKmDwuILXaVGVu9A,314
+kerykeion/kr_types/kr_literals.py,sha256=Urk4wbRXeCOMhJEIkfvwTWrbU-Z5csDnh03hVwxpMbc,3140
+kerykeion/kr_types/kr_models.py,sha256=eZU3CYFjK2f2JvwNneUUHrBVPmS55u6PMywHv1VD9LA,3524
+kerykeion/kr_types/settings_models.py,sha256=Gh467QjvlGmheD6eJI1IHpuK4cz_hbtjGTJT_1NMoAE,12376
+kerykeion/relationship_score.py,sha256=R9JugfK5_gJgr5ND-EghkqpqZcutzzKlJ-2JnYUMVv4,6794
+kerykeion/report.py,sha256=kS5avIN119pJVapYjZOvabg77nEcA8sSrOuXbRifABk,2565
+kerykeion/settings/__init__.py,sha256=QQNFCl7sgN27MKaVscqtpPk10HGz4wZS3I_7KEGMaVA,69
+kerykeion/settings/kerykeion_settings.py,sha256=uRAbhJ0ZXAbGBPGJjhh5u8YX2phcXobEwJA646wMHcM,2347
+kerykeion/settings/kr.config.json,sha256=1Yhv9RGHom5U9e-JZZRWVfT2Ubllz2WrckdwadDWfyg,12282
+kerykeion/sweph/README.md,sha256=L7FtNAJTWtrZNGKa8MX87SjduFYPYxwWhaI5fmtzNZo,73
+kerykeion/sweph/seas_18.se1,sha256=X9nCqhZU43wJpq61WAdueVQJt9xL2UjrwPqn1Kdoa1s,223002
+kerykeion/utilities.py,sha256=1GxV7Du2L9QZEwNKc0oDjNsEddpAFCqY_kyWx38IRiA,11392
+kerykeion-4.12.3.dist-info/LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
+kerykeion-4.12.3.dist-info/METADATA,sha256=8W1pRQlQ5UwY81Ukt1l4ICIGdQqMZRmWl5zVyLgj7ao,14410
+kerykeion-4.12.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+kerykeion-4.12.3.dist-info/entry_points.txt,sha256=5SmANYscFDDTdeovHvGQ-cnj0hdFvGoxPaWLCpyDFnQ,49
+kerykeion-4.12.3.dist-info/RECORD,,

kerykeion-4.8.1.dist-info/RECORD

@@ -1,32 +0,0 @@
-LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
-kerykeion/__init__.py,sha256=Z2-gAp09RAl2_WwzPO-OTc4ZRDLh54kTduAoy891gQc,3917
-kerykeion/aspects/__init__.py,sha256=9FlDVI1ndCJga0-chNIhcLitjU_x3kbtAFfFqVp2ejc,293
-kerykeion/aspects/aspects_utils.py,sha256=Rdo3ITDSU80n6U7aazpzzK4ruv7Iui2PaI3zMGqu1NQ,5832
-kerykeion/aspects/natal_aspects.py,sha256=m3_v1dM6YXvENZ6iN_EJkikKxySZBeR5QKhGsaChERk,4507
-kerykeion/aspects/synastry_aspects.py,sha256=uwg7Lc7wKnpxW9ydOdBHqx9cvO_t0ydGfIGluBIDD7c,3993
-kerykeion/astrological_subject.py,sha256=Z9QUNqX6mrOm4ihxmhH0hiMv6ilp_-0HCQ4u_feE73g,22956
-kerykeion/charts/__init__.py,sha256=Juxkduy2TaagWblh_7CE8Acrg3dHL27-WEddJhau_eQ,127
-kerykeion/charts/charts_utils.py,sha256=45Ee0Hj5nb30q97ggYTQEShxkbCPq65gI0-sE32UxDM,15112
-kerykeion/charts/kerykeion_chart_svg.py,sha256=vtTYgwXELnZoPKvySpEQRLZSaYVzzpDQBcUk9DwnQjw,60764
-kerykeion/charts/templates/chart.xml,sha256=njaX-1vglR7PFInmteCNHcxwMTjsMJPkW56TlJq0qxw,70158
-kerykeion/enums.py,sha256=Ben9GLYkPucpYY2ZDpURzUbNCc9jzK2MuaffkgiXFdQ,965
-kerykeion/fetch_geonames.py,sha256=ZWB1DbcH54ab3fQhzPhLY0Dz0OaPJqiHFn2e7DRr1MM,4588
-kerykeion/kr_types/__init__.py,sha256=-qhGQikurdoHnGtuT1bsaEeZ-IwmZtIHMjGOPC9_oqQ,295
-kerykeion/kr_types/chart_types.py,sha256=g9z53FTOsb2rusUG8nK4dtFgvVa6RCwAfAbrxFb9KaM,2180
-kerykeion/kr_types/kerykeion_exception.py,sha256=G-7VFta78qBt10l54JZWvwH-3lUNKmDwuILXaVGVu9A,314
-kerykeion/kr_types/kr_literals.py,sha256=Kc7LfdeTqHi5uDGoQHWsB81GTBc5E-fGxTJqWKK1FFU,1267
-kerykeion/kr_types/kr_models.py,sha256=3gyT4z-J9EM6p5175HKJX9q9WVWQTDt5Y_m3m8lZu9s,4260
-kerykeion/kr_types/settings_models.py,sha256=V4iEj7egXZHrWiV1cGQIezbtVmOKbOB-BRzPwa8WVtc,12683
-kerykeion/relationship_score.py,sha256=R9JugfK5_gJgr5ND-EghkqpqZcutzzKlJ-2JnYUMVv4,6794
-kerykeion/report.py,sha256=kS5avIN119pJVapYjZOvabg77nEcA8sSrOuXbRifABk,2565
-kerykeion/settings/__init__.py,sha256=QQNFCl7sgN27MKaVscqtpPk10HGz4wZS3I_7KEGMaVA,69
-kerykeion/settings/kerykeion_settings.py,sha256=uRAbhJ0ZXAbGBPGJjhh5u8YX2phcXobEwJA646wMHcM,2347
-kerykeion/settings/kr.config.json,sha256=1Yhv9RGHom5U9e-JZZRWVfT2Ubllz2WrckdwadDWfyg,12282
-kerykeion/sweph/README.md,sha256=L7FtNAJTWtrZNGKa8MX87SjduFYPYxwWhaI5fmtzNZo,73
-kerykeion/sweph/seas_18.se1,sha256=X9nCqhZU43wJpq61WAdueVQJt9xL2UjrwPqn1Kdoa1s,223002
-kerykeion/utilities.py,sha256=ncoXHvzXhNjhdm-uU6hMirVo287laq2GAJElNE6cBZM,10822
-kerykeion-4.8.1.dist-info/LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
-kerykeion-4.8.1.dist-info/METADATA,sha256=5KQpaw5C7-Ym6P1S6QJ8pIjMyOn4JlVh3cJrroZmluA,10351
-kerykeion-4.8.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-kerykeion-4.8.1.dist-info/entry_points.txt,sha256=5SmANYscFDDTdeovHvGQ-cnj0hdFvGoxPaWLCpyDFnQ,49
-kerykeion-4.8.1.dist-info/RECORD,,