faeruniancalendar


Namefaeruniancalendar JSON
Version 1.0.0 PyPI version JSON
download
home_page
SummaryA Python module for calculating Faerunian date information based on the Gregorian calendar.
upload_time2024-02-04 05:38:43
maintainer
docs_urlNone
author
requires_python>=3
license## MIT License Copyright (c) 2024 - Sebastian Bingham Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: **The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.** THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords date calculation faerun faerunian
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Faerunian Date Calculator

A Python module for calculating Faerunian date information based on the Gregorian calendar.

![PyPI - Version](https://img.shields.io/pypi/v/faeruniancalendar)
![Development Status](https://img.shields.io/badge/Development%20Status-4%20Beta-brightgreen)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## Overview

This Python module provides a functionality to calculate various Faerunian date-related information based on a given
date or the current date in the Gregorian calendar. It includes information such as the Faerunian date, name,
description, and additional year differences.

## Installation

Use `pip` to install `faeruniancalendar`.

    pip install faeruniancalendar

## Usage

Once installed import the module and use `get_raw_farray`. This is currently the only active function. It will return a
data dictionary. See the examples below.

Usage

    import faeruniancalendar
    
    print(faeruniancalendar.get_raw_farray('1988-01-24'))

Output

    {'g_date': 24, 'f_special': None, 'f_month_name': 'Hammer', 'f_month_desc': 'Deepwinter', 'f_tenday': 3,'f_day_of_week': 4, 'f_day': 24, 'f_short_format': '24 Hammer', 'f_long_format': 'the 24th of Hammer', 'f_poetic_long': 'the 24th of Deepwinter', 'events': [], 'dr_year': 1730, 'cr_year': 1705, 'nr_year': 698, 'wy_year': 2818}

## License

This software is distributed under the MIT License. You are free to use, modify, and distribute it according to the
terms and conditions of the license.

## Development Status

This software is currently in development and is not yet ready for production use. Please be aware of potential changes
and updates as development progresses.




            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "faeruniancalendar",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "date calculation,faerun,faerunian",
    "author": "",
    "author_email": "Sebastian Bingham <sebastian@sebastianbingham.com>",
    "download_url": "https://files.pythonhosted.org/packages/e7/b5/a7ee2c534fa959f5d9db595cb8073676eb70437229f9857443c2e37db9ae/faeruniancalendar-1.0.0.tar.gz",
    "platform": null,
    "description": "# Faerunian Date Calculator\n\nA Python module for calculating Faerunian date information based on the Gregorian calendar.\n\n![PyPI - Version](https://img.shields.io/pypi/v/faeruniancalendar)\n![Development Status](https://img.shields.io/badge/Development%20Status-4%20Beta-brightgreen)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n## Overview\n\nThis Python module provides a functionality to calculate various Faerunian date-related information based on a given\ndate or the current date in the Gregorian calendar. It includes information such as the Faerunian date, name,\ndescription, and additional year differences.\n\n## Installation\n\nUse `pip` to install `faeruniancalendar`.\n\n    pip install faeruniancalendar\n\n## Usage\n\nOnce installed import the module and use `get_raw_farray`. This is currently the only active function. It will return a\ndata dictionary. See the examples below.\n\nUsage\n\n    import faeruniancalendar\n    \n    print(faeruniancalendar.get_raw_farray('1988-01-24'))\n\nOutput\n\n    {'g_date': 24, 'f_special': None, 'f_month_name': 'Hammer', 'f_month_desc': 'Deepwinter', 'f_tenday': 3,'f_day_of_week': 4, 'f_day': 24, 'f_short_format': '24 Hammer', 'f_long_format': 'the 24th of Hammer', 'f_poetic_long': 'the 24th of Deepwinter', 'events': [], 'dr_year': 1730, 'cr_year': 1705, 'nr_year': 698, 'wy_year': 2818}\n\n## License\n\nThis software is distributed under the MIT License. You are free to use, modify, and distribute it according to the\nterms and conditions of the license.\n\n## Development Status\n\nThis software is currently in development and is not yet ready for production use. Please be aware of potential changes\nand updates as development progresses.\n\n\n\n",
    "bugtrack_url": null,
    "license": "## MIT License Copyright (c) 2024 - Sebastian Bingham  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  **The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.**  THE SOFTWARE IS PROVIDED \"AS IS,\" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "A Python module for calculating Faerunian date information based on the Gregorian calendar.",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/sebastianbingham/faeruniancalendar-python",
        "Issues": "https://github.com/sebastianbingham/faeruniancalendar-python/issues",
        "Repository": "https://github.com/sebastianbingham/faeruniancalendar-python.git"
    },
    "split_keywords": [
        "date calculation",
        "faerun",
        "faerunian"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52da80b3c16952d34e2fe7109b336eb4a8d20027155d5696c8bf19ac34656204",
                "md5": "2ea3521f2e44c2dd76722a16f57bdf39",
                "sha256": "b53d878d5cfb948a48833bc10aaf71c68733f24fae24eba3e4901108180fa5bf"
            },
            "downloads": -1,
            "filename": "faeruniancalendar-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2ea3521f2e44c2dd76722a16f57bdf39",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 17540,
            "upload_time": "2024-02-04T05:38:42",
            "upload_time_iso_8601": "2024-02-04T05:38:42.299855Z",
            "url": "https://files.pythonhosted.org/packages/52/da/80b3c16952d34e2fe7109b336eb4a8d20027155d5696c8bf19ac34656204/faeruniancalendar-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e7b5a7ee2c534fa959f5d9db595cb8073676eb70437229f9857443c2e37db9ae",
                "md5": "bd5c859706330a41324e84b2391270d9",
                "sha256": "1b5176a3b33781d945ac5c708497dfc685f99c5a3974ddf5597350ff2700f5fb"
            },
            "downloads": -1,
            "filename": "faeruniancalendar-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bd5c859706330a41324e84b2391270d9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 17304,
            "upload_time": "2024-02-04T05:38:43",
            "upload_time_iso_8601": "2024-02-04T05:38:43.835870Z",
            "url": "https://files.pythonhosted.org/packages/e7/b5/a7ee2c534fa959f5d9db595cb8073676eb70437229f9857443c2e37db9ae/faeruniancalendar-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-04 05:38:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sebastianbingham",
    "github_project": "faeruniancalendar-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "faeruniancalendar"
}
        
Elapsed time: 0.53222s