tzolkin-calendar 0.9.0

Program to calculate and convert Tzolk’in/Maya calendar dates.

tzolkin-calendar - Converter for Maya Tzolk’in Dates

This program converts mayan Tzolk’in dates to gregorian dates and vice versa. If you want to know more about the maya calendar systems, see Links.

Information about the installation and usage you find at Installation and Usage

more badges

Table of Contents

• tzolkin-calendar - Converter for Maya Tzolk’in Dates
  • Links
  • Installation and Usage
    • Prerequisites
    • Installation
    • Usage
    • More information
  • Contributing
    • Report Issues (Bugs and Feature Requests)
    • Changing the Documentation and Source Code
    • Github Documentation on Collaborating with Issues and Pull Requests
  • License
  • Badges
    • External Checks
    • Static Code Checks
    • Tests

Links

Smithsonian Museo Nacional del Indígena Americano: Viviendo El Tiempo Maya

Website of the Smithsonian National Museum of the American Indian on Mayas Living Maya Time.

Online general Maya (not only Tzolk’in) calendar converter: Maya Converter of the Smithsonian NMAI

Convertidor Al Calendario Maya Smithsonian NMIA

Mayan Glyphs and Unicode: Roadmap to the SMP and the PDF Updated List of Characters for Mayan Codices

Installation and Usage

Prerequisites

You need Python, at least version 3.9 to be able to use tzolkin-calendar. You can download it from python.org.

To install the package, you need pip, see Installing pip.

Installation

Install the package using pip on a shell or command prompt:

python -m pip install tzolkin-calendar

More information about using pip you get at pip Quickstart

Usage

More information

Detailed information is available at the documentation website.

Contributing

Any help is welcome!

If you encounter a problem using tzolkin-calendar, a task it not as easy as you'd like it to be or you'd like something added to it: open an issue at GitHub.

Report Issues (Bugs and Feature Requests)

File a bug report at Github

Add a feature request at Github

Changing the Documentation and Source Code

If you'd like to contribute directly, e.g. better the documentation, add another language or write some source code: fork tzolkin-calendar by clicking the Fork-button in the upper right corner of the GitHub project website. Check out your fork of tzolkin-calendar using the URL from the Code-button of your fork on Github. The URL should be something like github.com/YOUR_USERNAME/tzolkin-calendar.git.

Details about how to fork a repository on Github are here

and set up the development environment using pipenv.

First, install pipenv if you don't already have it installed:

python -m pip install --upgrade pipenv

and install all needed packages to develop tzolkin-calender:

cd tzolkin-calendar
python -m pipenv install --dev

That command installs all packages in Pipfile/Pipfile.lock in the directory tzolkin-calender, the root directory of tzolkin-calendar.

More information about pipenv can be found at Pipenv.

Make your changes, push them to your forked repository and make a pull-request (e.g. using the Pull request-button above and right of GitHubs source file view).

See GitHub on Pull-Requests

Github Documentation on Collaborating with Issues and Pull Requests

See GitHub's documentation about how to contribute for details: Contributing at Github

License

Everything in tzolkin-calendar is licensed under the MIT license, see file LICENSE

Badges

External Checks

Static Code Checks

Tests