Utilities for managing the fiscal calendar
Project description
Overview
fiscalyear is a small, lightweight Python module providing helpful utilities for managing the fiscal calendar. It is designed as an extension of the built-in datetime and calendar modules, adding the ability to query the fiscal year, fiscal quarter, fiscal month, and fiscal day of a date or datetime object.
Basic Usage
fiscalyear provides several useful classes.
FiscalYear
The FiscalYear class provides an object for storing information about the start and end of a particular fiscal year.
>>> from fiscalyear import *
>>> a = FiscalYear(2017)
>>> a.start
FiscalDateTime(2016, 10, 1, 0, 0)
>>> a.end
FiscalDateTime(2017, 9, 30, 23, 59, 59)
>>> a.isleap
False
You can also get the current FiscalYear with:
>>> FiscalYear.current()
FiscalYear(2018)
FiscalQuarter
The FiscalYear class also allows you to query information about a specific fiscal quarter.
>>> a.q3.start
FiscalDateTime(2017, 4, 1, 0, 0)
>>> a.q3.end
FiscalDateTime(2017, 6, 30, 23, 59, 59)
These objects represent the standalone FiscalQuarter class.
>>> b = FiscalQuarter(2017, 3)
>>> b.start
FiscalDateTime(2017, 4, 1, 0, 0)
>>> b.end
FiscalDateTime(2017, 6, 30, 23, 59, 59)
>>> a.q3 == b
True
>>> b in a
True
>>> b.next_fiscal_quarter
FiscalQuarter(2017, 4)
You can also get the current FiscalQuarter with:
>>> FiscalQuarter.current()
FiscalQuarter(2018, 2)
FiscalMonth
The FiscalMonth class allows you to keep track of the fiscal month.
>>> c = FiscalMonth(2017, 9)
>>> c.start
FiscalDateTime(2017, 6, 1, 0, 0)
>>> c.end
FiscalDateTime(2017, 6, 30, 23, 59, 59)
>>> c in a
True
>>> c in b
True
>>> c.next_fiscal_month
FiscalMonth(2017, 10)
You can also get the current FiscalMonth with:
>>> FiscalMonth.current()
FiscalMonth(2018, 4)
FiscalDay
To keep track of the fiscal day, use the FiscalDay class.
>>> d = FiscalDay(2017, 250)
>>> d.start
FiscalDateTime(2017, 6, 6, 0, 0)
>>> d.end
FiscalDateTime(2017, 6, 6, 23, 59, 59)
>>> d in a
True
>>> d in b
True
>>> d in c
True
>>> d.next_fiscal_day
FiscalDay(2017, 251)
You can also get the current FiscalDay with:
>>> FiscalDay.current()
FiscalDay(2018, 94)
FiscalDateTime
The start and end of each of the above objects are stored as instances of the FiscalDateTime class. This class provides all of the same features as the datetime class, with the addition of the ability to query the fiscal year, fiscal quarter, fiscal month, and fiscal day.
>>> e = FiscalDateTime.now()
>>> e
FiscalDateTime(2017, 4, 8, 20, 30, 31, 105323)
>>> e.fiscal_year
2017
>>> e.fiscal_quarter
3
>>> e.next_fiscal_quarter
FiscalQuarter(2017, 4)
>>> e.fiscal_month
7
>>> e.fiscal_day
190
FiscalDate
If you don’t care about the time component of the FiscalDateTime class, the FiscalDate class is right for you.
>>> f = FiscalDate.today()
>>> f
FiscalDate(2017, 4, 8)
>>> f.fiscal_year
2017
>>> f.prev_fiscal_year
FiscalYear(2016)
Installation
fiscalyear has no dependencies, making it simple and easy to install. The recommended way to install fiscalyear is with pip.
$ pip install fiscalyear
For alternate installation methods, see the Installation Documentation.
Documentation
Documentation is hosted on Read the Docs.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file fiscalyear-0.3.2.tar.gz
.
File metadata
- Download URL: fiscalyear-0.3.2.tar.gz
- Upload date:
- Size: 21.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0697b2af4ab2d4c6188fac33d340f31dea9b0e1f0d3666d6752faeedd744f019 |
|
MD5 | 18c80fc7a7bef223cb0cac35e5967008 |
|
BLAKE2b-256 | cba11c285645ac8348ddeff6c4cf0df254c12489c0caf211d86fd2db362483c3 |
File details
Details for the file fiscalyear-0.3.2-py3-none-any.whl
.
File metadata
- Download URL: fiscalyear-0.3.2-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 183ca2f590d6e4fc27780c7078fb825235cb6dbd3dd2857b3a4828b3ef21c5bd |
|
MD5 | 05eb4795b61941358333ca69a63aae62 |
|
BLAKE2b-256 | 51f2c3185bf5089738c75fc5964b7fb3aaaeeb4c636c7e95d55de7ad50b2324d |
File details
Details for the file fiscalyear-0.3.2-py2-none-any.whl
.
File metadata
- Download URL: fiscalyear-0.3.2-py2-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79f0cdc1fa8334397863b12c915951e6279261c27db2948168d36b375a32ec1b |
|
MD5 | 65f976a2506a39027d8062b47a4374d5 |
|
BLAKE2b-256 | 0ad964149117d26f000ef1b4e32e6e5a3fb84426057cab003d30b944b16bea0e |