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 and fiscal quarter 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)
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 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
You can also get the current FiscalQuarter with:
>>> FiscalQuarter.current()
FiscalQuarter(2018, 2)
FiscalDateTime
The start and end of each quarter 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 and quarter.
>>> c = FiscalDateTime.now()
>>> c
FiscalDateTime(2017, 4, 8, 20, 30, 31, 105323)
>>> c.fiscal_year
2017
>>> c.quarter
3
>>> c.next_quarter
FiscalQuarter(2017, 4)
FiscalDate
If you don’t care about the time component of the FiscalDateTime class, the FiscalDate class is right for you.
>>> d = FiscalDate.today()
>>> d
FiscalDate(2017, 4, 8)
>>> d.fiscal_year
2017
>>> d.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
File details
Details for the file fiscalyear-0.2.0.tar.gz
.
File metadata
- Download URL: fiscalyear-0.2.0.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f513616aeb03046406c56d7c69cd9e26f6a12963c71c1410cc3d4532a5bfee71 |
|
MD5 | ef16ad4b13f24f10fb56328e227f367f |
|
BLAKE2b-256 | 97d28e67500043411e498f55e5c8a962f68dfda6a54c3098ff98154e111c8ac3 |