├── .coveragerc
├── .github
└── workflows
│ ├── deploy-on-pypi.yml
│ └── test-jalali-pandas.yml
├── .gitignore
├── .pre-commit-config.yaml
├── .pylintrc
├── LICENSE
├── README.md
├── docs
├── _config.yml
├── assets
│ └── github-jalali-pandas.png
└── index.md
├── examples
└── basic_usage.ipynb
├── jalali_pandas
├── __init__.py
├── df_handler.py
└── serie_handler.py
├── poetry.lock
├── pyproject.toml
├── requirements.txt
└── tests
├── __init__.py
├── df_test.py
└── series_test.py
/.coveragerc :
--------------------------------------------------------------------------------
1 | [run]
2 | source=jalali_pandas
3 |
--------------------------------------------------------------------------------
/.github/workflows/deploy-on-pypi.yml:
--------------------------------------------------------------------------------
1 | name: Python package
2 | on:
3 | push:
4 | tags:
5 | - "v*.*.*"
6 | jobs:
7 | build:
8 | runs-on: ubuntu-latest
9 | steps:
10 | - uses: actions/checkout@v2
11 | - name: Build and publish to pypi
12 | uses: JRubics/poetry-publish@v1.10
13 | with:
14 | pypi_token: ${{ secrets.PYPI_TOKEN }}
15 |
--------------------------------------------------------------------------------
/.github/workflows/test-jalali-pandas.yml:
--------------------------------------------------------------------------------
1 | name: code-coverage
2 |
3 | on: [push]
4 | jobs:
5 | run:
6 | runs-on: ${{ matrix.os }}
7 | strategy:
8 | matrix:
9 | os: [ubuntu-latest]
10 | env:
11 | OS: ${{ matrix.os }}
12 | PYTHON: '3.8'
13 | steps:
14 | - uses: actions/checkout@master
15 | - name: Setup Python
16 | uses: actions/setup-python@master
17 | with:
18 | python-version: 3.8
19 | - name: Generate coverage report
20 | run: |
21 | pip install pytest
22 | pip install pytest-cov
23 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
24 |
25 | pytest --cov=jalali_pandas --cov-report=xml
26 | - name: Upload coverage to Codecov
27 | uses: codecov/codecov-action@v2
28 | with:
29 | token: ${{ secrets.CODECOV_TOKEN }}
30 | env_vars: OS,PYTHON
31 | fail_ci_if_error: false
32 | name: codecov-umbrella
33 | verbose: true
34 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | pip-wheel-metadata/
24 | share/python-wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 | MANIFEST
29 |
30 | # PyInstaller
31 | # Usually these files are written by a python script from a template
32 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 |
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 |
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .nox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | *.py,cover
51 | .hypothesis/
52 | .pytest_cache/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | target/
76 |
77 | # Jupyter Notebook
78 | .ipynb_checkpoints
79 |
80 | # IPython
81 | profile_default/
82 | ipython_config.py
83 |
84 | # pyenv
85 | .python-version
86 |
87 | # pipenv
88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
91 | # install all needed dependencies.
92 | #Pipfile.lock
93 |
94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95 | __pypackages__/
96 |
97 | # Celery stuff
98 | celerybeat-schedule
99 | celerybeat.pid
100 |
101 | # SageMath parsed files
102 | *.sage.py
103 |
104 | # Environments
105 | .env
106 | .venv
107 | env/
108 | venv/
109 | ENV/
110 | env.bak/
111 | venv.bak/
112 |
113 | # Spyder project settings
114 | .spyderproject
115 | .spyproject
116 |
117 | # Rope project settings
118 | .ropeproject
119 |
120 | # mkdocs documentation
121 | /site
122 |
123 | # mypy
124 | .mypy_cache/
125 | .dmypy.json
126 | dmypy.json
127 |
128 | # Pyre type checker
129 | .pyre/
130 |
131 |
132 | .vscode/
133 |
--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
1 | repos:
2 | - repo: https://github.com/pre-commit/pre-commit-hooks
3 | rev: v4.0.1
4 | hooks:
5 | - id: check-yaml
6 | - id: end-of-file-fixer
7 | - id: trailing-whitespace
8 | - repo: https://github.com/psf/black
9 | rev: 21.10b0
10 | hooks:
11 | - id: black
12 |
13 | - repo: local
14 | hooks:
15 | - id: pylint
16 | name: pylint
17 | entry: pylint
18 | language: python
19 | types: [python]
20 | args: [--rcfile=.pylintrc]
21 |
--------------------------------------------------------------------------------
/.pylintrc:
--------------------------------------------------------------------------------
1 | [MASTER]
2 | # A comma-separated list of package or module names from where C extensions may
3 | # be loaded. Extensions are loading into the active Python interpreter and may
4 | # run arbitrary code.
5 | extension-pkg-allow-list=
6 |
7 | # A comma-separated list of package or module names from where C extensions may
8 | # be loaded. Extensions are loading into the active Python interpreter and may
9 | # run arbitrary code. (This is an alternative name to extension-pkg-allow-list
10 | # for backward compatibility.)
11 | extension-pkg-whitelist=
12 |
13 | # Return non-zero exit code if any of these messages/categories are detected,
14 | # even if score is above --fail-under value. Syntax same as enable. Messages
15 | # specified are enabled, while categories only check already-enabled messages.
16 | fail-on=
17 |
18 | # Specify a score threshold to be exceeded before program exits with error.
19 | fail-under=10.0
20 |
21 | # Files or directories to be skipped. They should be base names, not paths.
22 | ignore=CVS
23 |
24 | # Add files or directories matching the regex patterns to the ignore-list. The
25 | # regex matches against paths.
26 | ignore-paths=
27 |
28 | # Files or directories matching the regex patterns are skipped. The regex
29 | # matches against base names, not paths.
30 | ignore-patterns=
31 |
32 | # Python code to execute, usually for sys.path manipulation such as
33 | # pygtk.require().
34 | #init-hook=
35 |
36 | # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
37 | # number of processors available to use.
38 | jobs=1
39 |
40 | # Control the amount of potential inferred values when inferring a single
41 | # object. This can help the performance when dealing with large functions or
42 | # complex, nested conditions.
43 | limit-inference-results=100
44 |
45 | # List of plugins (as comma separated values of python module names) to load,
46 | # usually to register additional checkers.
47 | load-plugins=
48 |
49 | # Pickle collected data for later comparisons.
50 | persistent=yes
51 |
52 | # Min Python version to use for version dependend checks. Will default to the
53 | # version used to run pylint.
54 | py-version=3.8
55 |
56 | # When enabled, pylint would attempt to guess common misconfiguration and emit
57 | # user-friendly hints instead of false-positive error messages.
58 | suggestion-mode=yes
59 |
60 | # Allow loading of arbitrary C extensions. Extensions are imported into the
61 | # active Python interpreter and may run arbitrary code.
62 | unsafe-load-any-extension=no
63 |
64 |
65 | [MESSAGES CONTROL]
66 |
67 | # Only show warnings with the listed confidence levels. Leave empty to show
68 | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
69 | confidence=
70 |
71 | # Disable the message, report, category or checker with the given id(s). You
72 | # can either give multiple identifiers separated by comma (,) or put this
73 | # option multiple times (only on the command line, not in the configuration
74 | # file where it should appear only once). You can also use "--disable=all" to
75 | # disable everything first and then reenable specific checks. For example, if
76 | # you want to run only the similarities checker, you can use "--disable=all
77 | # --enable=similarities". If you want to run only the classes checker, but have
78 | # no Warning level messages displayed, use "--disable=all --enable=classes
79 | # --disable=W".
80 | disable=raw-checker-failed,
81 | bad-inline-option,
82 | locally-disabled,
83 | file-ignored,
84 | suppressed-message,
85 | useless-suppression,
86 | deprecated-pragma,
87 | use-symbolic-message-instead
88 |
89 | # Enable the message, report, category or checker with the given id(s). You can
90 | # either give multiple identifier separated by comma (,) or put this option
91 | # multiple time (only on the command line, not in the configuration file where
92 | # it should appear only once). See also the "--disable" option for examples.
93 | enable=c-extension-no-member
94 |
95 |
96 | [REPORTS]
97 |
98 | # Python expression which should return a score less than or equal to 10. You
99 | # have access to the variables 'error', 'warning', 'refactor', and 'convention'
100 | # which contain the number of messages in each category, as well as 'statement'
101 | # which is the total number of statements analyzed. This score is used by the
102 | # global evaluation report (RP0004).
103 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
104 |
105 | # Template used to display messages. This is a python new-style format string
106 | # used to format the message information. See doc for all details.
107 | #msg-template=
108 |
109 | # Set the output format. Available formats are text, parseable, colorized, json
110 | # and msvs (visual studio). You can also give a reporter class, e.g.
111 | # mypackage.mymodule.MyReporterClass.
112 | output-format=text
113 |
114 | # Tells whether to display a full report or only the messages.
115 | reports=no
116 |
117 | # Activate the evaluation score.
118 | score=yes
119 |
120 |
121 | [REFACTORING]
122 |
123 | # Maximum number of nested blocks for function / method body
124 | max-nested-blocks=5
125 |
126 | # Complete name of functions that never returns. When checking for
127 | # inconsistent-return-statements if a never returning function is called then
128 | # it will be considered as an explicit return statement and no message will be
129 | # printed.
130 | never-returning-functions=sys.exit,argparse.parse_error
131 |
132 |
133 | [LOGGING]
134 |
135 | # The type of string formatting that logging methods do. `old` means using %
136 | # formatting, `new` is for `{}` formatting.
137 | logging-format-style=old
138 |
139 | # Logging modules to check that the string format arguments are in logging
140 | # function parameter format.
141 | logging-modules=logging
142 |
143 |
144 | [SPELLING]
145 |
146 | # Limits count of emitted suggestions for spelling mistakes.
147 | max-spelling-suggestions=4
148 |
149 | # Spelling dictionary name. Available dictionaries: none. To make it work,
150 | # install the 'python-enchant' package.
151 | spelling-dict=
152 |
153 | # List of comma separated words that should be considered directives if they
154 | # appear and the beginning of a comment and should not be checked.
155 | spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
156 |
157 | # List of comma separated words that should not be checked.
158 | spelling-ignore-words=
159 |
160 | # A path to a file that contains the private dictionary; one word per line.
161 | spelling-private-dict-file=
162 |
163 | # Tells whether to store unknown words to the private dictionary (see the
164 | # --spelling-private-dict-file option) instead of raising a message.
165 | spelling-store-unknown-words=no
166 |
167 |
168 | [MISCELLANEOUS]
169 |
170 | # List of note tags to take in consideration, separated by a comma.
171 | notes=FIXME,
172 | XXX,
173 | TODO
174 |
175 | # Regular expression of note tags to take in consideration.
176 | #notes-rgx=
177 |
178 |
179 | [TYPECHECK]
180 |
181 | # List of decorators that produce context managers, such as
182 | # contextlib.contextmanager. Add to this list to register other decorators that
183 | # produce valid context managers.
184 | contextmanager-decorators=contextlib.contextmanager
185 |
186 | # List of members which are set dynamically and missed by pylint inference
187 | # system, and so shouldn't trigger E1101 when accessed. Python regular
188 | # expressions are accepted.
189 | generated-members=
190 |
191 | # Tells whether missing members accessed in mixin class should be ignored. A
192 | # mixin class is detected if its name ends with "mixin" (case insensitive).
193 | ignore-mixin-members=yes
194 |
195 | # Tells whether to warn about missing members when the owner of the attribute
196 | # is inferred to be None.
197 | ignore-none=yes
198 |
199 | # This flag controls whether pylint should warn about no-member and similar
200 | # checks whenever an opaque object is returned when inferring. The inference
201 | # can return multiple potential results while evaluating a Python object, but
202 | # some branches might not be evaluated, which results in partial inference. In
203 | # that case, it might be useful to still emit no-member and other checks for
204 | # the rest of the inferred objects.
205 | ignore-on-opaque-inference=yes
206 |
207 | # List of class names for which member attributes should not be checked (useful
208 | # for classes with dynamically set attributes). This supports the use of
209 | # qualified names.
210 | ignored-classes=optparse.Values,thread._local,_thread._local
211 |
212 | # List of module names for which member attributes should not be checked
213 | # (useful for modules/projects where namespaces are manipulated during runtime
214 | # and thus existing member attributes cannot be deduced by static analysis). It
215 | # supports qualified module names, as well as Unix pattern matching.
216 | ignored-modules=
217 |
218 | # Show a hint with possible names when a member name was not found. The aspect
219 | # of finding the hint is based on edit distance.
220 | missing-member-hint=yes
221 |
222 | # The minimum edit distance a name should have in order to be considered a
223 | # similar match for a missing member name.
224 | missing-member-hint-distance=1
225 |
226 | # The total number of similar names that should be taken in consideration when
227 | # showing a hint for a missing member.
228 | missing-member-max-choices=1
229 |
230 | # List of decorators that change the signature of a decorated function.
231 | signature-mutators=
232 |
233 |
234 | [VARIABLES]
235 |
236 | # List of additional names supposed to be defined in builtins. Remember that
237 | # you should avoid defining new builtins when possible.
238 | additional-builtins=
239 |
240 | # Tells whether unused global variables should be treated as a violation.
241 | allow-global-unused-variables=yes
242 |
243 | # List of names allowed to shadow builtins
244 | allowed-redefined-builtins=
245 |
246 | # List of strings which can identify a callback function by name. A callback
247 | # name must start or end with one of those strings.
248 | callbacks=cb_,
249 | _cb
250 |
251 | # A regular expression matching the name of dummy variables (i.e. expected to
252 | # not be used).
253 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
254 |
255 | # Argument names that match this expression will be ignored. Default to name
256 | # with leading underscore.
257 | ignored-argument-names=_.*|^ignored_|^unused_
258 |
259 | # Tells whether we should check for unused import in __init__ files.
260 | init-import=no
261 |
262 | # List of qualified module names which can have objects that can redefine
263 | # builtins.
264 | redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
265 |
266 |
267 | [FORMAT]
268 |
269 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
270 | expected-line-ending-format=
271 |
272 | # Regexp for a line that is allowed to be longer than the limit.
273 | ignore-long-lines=^\s*(# )??$
274 |
275 | # Number of spaces of indent required inside a hanging or continued line.
276 | indent-after-paren=4
277 |
278 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
279 | # tab).
280 | indent-string=' '
281 |
282 | # Maximum number of characters on a single line.
283 | max-line-length=100
284 |
285 | # Maximum number of lines in a module.
286 | max-module-lines=1000
287 |
288 | # Allow the body of a class to be on the same line as the declaration if body
289 | # contains single statement.
290 | single-line-class-stmt=no
291 |
292 | # Allow the body of an if to be on the same line as the test if there is no
293 | # else.
294 | single-line-if-stmt=no
295 |
296 |
297 | [SIMILARITIES]
298 |
299 | # Comments are removed from the similarity computation
300 | ignore-comments=yes
301 |
302 | # Docstrings are removed from the similarity computation
303 | ignore-docstrings=yes
304 |
305 | # Imports are removed from the similarity computation
306 | ignore-imports=no
307 |
308 | # Signatures are removed from the similarity computation
309 | ignore-signatures=no
310 |
311 | # Minimum lines number of a similarity.
312 | min-similarity-lines=4
313 |
314 |
315 | [BASIC]
316 |
317 | # Naming style matching correct argument names.
318 | argument-naming-style=snake_case
319 |
320 | # Regular expression matching correct argument names. Overrides argument-
321 | # naming-style.
322 | #argument-rgx=
323 |
324 | # Naming style matching correct attribute names.
325 | attr-naming-style=snake_case
326 |
327 | # Regular expression matching correct attribute names. Overrides attr-naming-
328 | # style.
329 | #attr-rgx=
330 |
331 | # Bad variable names which should always be refused, separated by a comma.
332 | bad-names=foo,
333 | bar,
334 | baz,
335 | toto,
336 | tutu,
337 | tata
338 |
339 | # Bad variable names regexes, separated by a comma. If names match any regex,
340 | # they will always be refused
341 | bad-names-rgxs=
342 |
343 | # Naming style matching correct class attribute names.
344 | class-attribute-naming-style=any
345 |
346 | # Regular expression matching correct class attribute names. Overrides class-
347 | # attribute-naming-style.
348 | #class-attribute-rgx=
349 |
350 | # Naming style matching correct class constant names.
351 | class-const-naming-style=UPPER_CASE
352 |
353 | # Regular expression matching correct class constant names. Overrides class-
354 | # const-naming-style.
355 | #class-const-rgx=
356 |
357 | # Naming style matching correct class names.
358 | class-naming-style=PascalCase
359 |
360 | # Regular expression matching correct class names. Overrides class-naming-
361 | # style.
362 | #class-rgx=
363 |
364 | # Naming style matching correct constant names.
365 | const-naming-style=UPPER_CASE
366 |
367 | # Regular expression matching correct constant names. Overrides const-naming-
368 | # style.
369 | #const-rgx=
370 |
371 | # Minimum line length for functions/classes that require docstrings, shorter
372 | # ones are exempt.
373 | docstring-min-length=-1
374 |
375 | # Naming style matching correct function names.
376 | function-naming-style=snake_case
377 |
378 | # Regular expression matching correct function names. Overrides function-
379 | # naming-style.
380 | #function-rgx=
381 |
382 | # Good variable names which should always be accepted, separated by a comma.
383 | good-names=i,
384 | j,
385 | k,
386 | ex,
387 | Run,
388 | _,
389 | df
390 |
391 | # Good variable names regexes, separated by a comma. If names match any regex,
392 | # they will always be accepted
393 | good-names-rgxs=
394 |
395 | # Include a hint for the correct naming format with invalid-name.
396 | include-naming-hint=no
397 |
398 | # Naming style matching correct inline iteration names.
399 | inlinevar-naming-style=any
400 |
401 | # Regular expression matching correct inline iteration names. Overrides
402 | # inlinevar-naming-style.
403 | #inlinevar-rgx=
404 |
405 | # Naming style matching correct method names.
406 | method-naming-style=snake_case
407 |
408 | # Regular expression matching correct method names. Overrides method-naming-
409 | # style.
410 | #method-rgx=
411 |
412 | # Naming style matching correct module names.
413 | module-naming-style=snake_case
414 |
415 | # Regular expression matching correct module names. Overrides module-naming-
416 | # style.
417 | #module-rgx=
418 |
419 | # Colon-delimited sets of names that determine each other's naming style when
420 | # the name regexes allow several styles.
421 | name-group=
422 |
423 | # Regular expression which should only match function or class names that do
424 | # not require a docstring.
425 | no-docstring-rgx=^_
426 |
427 | # List of decorators that produce properties, such as abc.abstractproperty. Add
428 | # to this list to register other decorators that produce valid properties.
429 | # These decorators are taken in consideration only for invalid-name.
430 | property-classes=abc.abstractproperty
431 |
432 | # Naming style matching correct variable names.
433 | variable-naming-style=snake_case
434 |
435 | # Regular expression matching correct variable names. Overrides variable-
436 | # naming-style.
437 | #variable-rgx=
438 |
439 |
440 | [STRING]
441 |
442 | # This flag controls whether inconsistent-quotes generates a warning when the
443 | # character used as a quote delimiter is used inconsistently within a module.
444 | check-quote-consistency=no
445 |
446 | # This flag controls whether the implicit-str-concat should generate a warning
447 | # on implicit string concatenation in sequences defined over several lines.
448 | check-str-concat-over-line-jumps=no
449 |
450 |
451 | [IMPORTS]
452 |
453 | # List of modules that can be imported at any level, not just the top level
454 | # one.
455 | allow-any-import-level=
456 |
457 | # Allow wildcard imports from modules that define __all__.
458 | allow-wildcard-with-all=no
459 |
460 | # Analyse import fallback blocks. This can be used to support both Python 2 and
461 | # 3 compatible code, which means that the block might have code that exists
462 | # only in one or another interpreter, leading to false positives when analysed.
463 | analyse-fallback-blocks=no
464 |
465 | # Deprecated modules which should not be used, separated by a comma.
466 | deprecated-modules=
467 |
468 | # Output a graph (.gv or any supported image format) of external dependencies
469 | # to the given file (report RP0402 must not be disabled).
470 | ext-import-graph=
471 |
472 | # Output a graph (.gv or any supported image format) of all (i.e. internal and
473 | # external) dependencies to the given file (report RP0402 must not be
474 | # disabled).
475 | import-graph=
476 |
477 | # Output a graph (.gv or any supported image format) of internal dependencies
478 | # to the given file (report RP0402 must not be disabled).
479 | int-import-graph=
480 |
481 | # Force import order to recognize a module as part of the standard
482 | # compatibility libraries.
483 | known-standard-library=
484 |
485 | # Force import order to recognize a module as part of a third party library.
486 | known-third-party=enchant
487 |
488 | # Couples of modules and preferred modules, separated by a comma.
489 | preferred-modules=
490 |
491 |
492 | [CLASSES]
493 |
494 | # Warn about protected attribute access inside special methods
495 | check-protected-access-in-special-methods=no
496 |
497 | # List of method names used to declare (i.e. assign) instance attributes.
498 | defining-attr-methods=__init__,
499 | __new__,
500 | setUp,
501 | __post_init__
502 |
503 | # List of member names, which should be excluded from the protected access
504 | # warning.
505 | exclude-protected=_asdict,
506 | _fields,
507 | _replace,
508 | _source,
509 | _make
510 |
511 | # List of valid names for the first argument in a class method.
512 | valid-classmethod-first-arg=cls
513 |
514 | # List of valid names for the first argument in a metaclass class method.
515 | valid-metaclass-classmethod-first-arg=cls
516 |
517 |
518 | [DESIGN]
519 |
520 | # List of qualified class names to ignore when counting class parents (see
521 | # R0901)
522 | ignored-parents=
523 |
524 | # Maximum number of arguments for function / method.
525 | max-args=5
526 |
527 | # Maximum number of attributes for a class (see R0902).
528 | max-attributes=7
529 |
530 | # Maximum number of boolean expressions in an if statement (see R0916).
531 | max-bool-expr=5
532 |
533 | # Maximum number of branch for function / method body.
534 | max-branches=12
535 |
536 | # Maximum number of locals for function / method body.
537 | max-locals=15
538 |
539 | # Maximum number of parents for a class (see R0901).
540 | max-parents=7
541 |
542 | # Maximum number of public methods for a class (see R0904).
543 | max-public-methods=20
544 |
545 | # Maximum number of return / yield for function / method body.
546 | max-returns=6
547 |
548 | # Maximum number of statements in function / method body.
549 | max-statements=50
550 |
551 | # Minimum number of public methods for a class (see R0903).
552 | min-public-methods=2
553 |
554 |
555 | [EXCEPTIONS]
556 |
557 | # Exceptions that will emit a warning when being caught. Defaults to
558 | # "BaseException, Exception".
559 | overgeneral-exceptions=BaseException,
560 | Exception
561 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](http://hits.dwyl.com/ghodsizadeh/jalali-pandas)
2 | 
3 | [](https://badge.fury.io/py/jalali-pandas)
4 | [](https://github.com/python/black)
5 | [](https://codecov.io/gh/ghodsizadeh/jalali-pandas)
6 | [](https://www.gnu.org/licenses/gpl-3.0)
7 | [](https://colab.research.google.com/github/ghodsizadeh/jalali-pandas/blob/main/examples/basic_usage.ipynb)
8 | 
9 |
10 | # Jalali Pandas Extentsion
11 |
12 | > A pandas extension that solves all problems of Jalai/Iraninan/Shamsi dates
13 |
14 | 
15 |
16 | ## Features
17 |
18 | #### Series Extenstion
19 |
20 | - Convert _string_ to _Jalali_ date `1388/03/25` --> `jdatetime(1388,3,25,0,0)`
21 | - Convert _gregorian_ date to _Jalali_ date `datetime(2019,11,17,0,0)` --> `jdatetime(1398,8,26,0,0)`
22 | - Convert _Jalali_ date to _gregorian_ date `jdatetime(1398,10,18,0,0)` --> `datetim(2020,1,8,6,19)`
23 |
24 | #### DataFrame extenstion
25 |
26 | - Support grouping by _Jalali_ date
27 | - Group by year, month, days, ...
28 | - Shortcuts for groups: `ymd` for `['year','month','day']` and more
29 | - Resampling: Convenience method for frequency conversion and resampling of time series but in _Jalali_ dateformat. (comming soon)
30 |
31 | ## Installation
32 |
33 | pip install -U jalali-pandas
34 |
35 | ## Usage
36 |
37 | Just import jalali-pandas and use pandas just use `.jalali` as a method for series and dataframes. Nothin outside pandas.
38 |
39 | > `jalali-pandas` is an extentsion for pandas, that add a mehtod for series/columns and dataframes.
40 |
41 | ### Series
42 |
43 | ```python
44 | import pandas as pd
45 | import jalali_pandas
46 |
47 | # create dataframe
48 | df = pd.DataFrame({"date": pd.date_range("2019-01-01", periods=10, freq="D")})
49 |
50 | # convert to jalali
51 | df["jdate"] = df["date"].jalali.to_jalali()
52 |
53 | # convert to gregorian
54 | df["gdate"] = df["jdate"].jalali.to_gregorian()
55 |
56 | # parse string to jalali
57 | df1 = pd.DataFrame({"date": ["1399/08/02", "1399/08/03", "1399/08/04"]})
58 | df1["jdate"] = df1["date"].jalali.parse_jalali("%Y/%m/%d")
59 |
60 |
61 | # get access to jalali year,quarter ,month, day and weekday
62 | df['year'] = df["jdate"].jalali.year
63 | df['month'] = df["jdate"].jalali.month
64 | df['quarter'] = df["jdate"].jalali.quarter
65 | df['day'] = df["jdate"].jalali.day
66 | df['weekday'] = df["jdate"].jalali.weekday
67 |
68 | ```
69 |
70 | ### DataFrame
71 |
72 | ```python
73 |
74 | import pandas as pd
75 | import jalali_pandas
76 |
77 | df = pd.DataFrame(
78 | {
79 | "date": pd.date_range("2019-01-01", periods=10, freq="M"),
80 | "value": range(10),
81 | }
82 | )
83 | # make sure to create a column with jalali datetime format. (you can use any name)
84 | df["jdate"] = df["date"].jalali.to_jalali()
85 |
86 |
87 | # group by jalali year
88 | gp = df.jalali.groupby("year")
89 | gp.sum()
90 |
91 | #group by month
92 | mean = df.jalali.groupby('mean')
93 |
94 | #groupby year and month and day
95 | mean = df.jalali.groupby('ymd')
96 | # or
97 | mean = df.jalali.groupby(['year','month','day'])
98 |
99 |
100 | #groupby year and quarter
101 | mean = df.jalali.groupby('yq')
102 | # or
103 | mean = df.jalali.groupby(['year','quarter'])
104 | ```
105 |
106 | ---
107 |
108 | # راهنمای فارسی
109 |
110 | برای مطالعه راهنمای فارسی استفاده از کتابخانه به این آدرس مراجعه کنید.
111 |
112 | [معرفی بسته pandas-jalali | آموزش کار با تاریخ شمسی در pandas](https://learnwithmehdi.ir/posts/jalali-pandas/)
113 | [معرفی بسته pandas-jalali | آموزش کار با تاریخ شمسی در pandas](https://learnwithmehdi.ir/posts/jalali-pandas/)
114 |
115 | ## راهنمای ویدیویی
116 |
117 | [](https://www.youtube.com/watch?v=PYS4Hxmzbyg)
118 |
119 | ## ToDos:
120 |
121 | - [x] add gregorian to Jalali Conversion
122 | - [x] add Jalali to gregorian Conversion
123 | - [ ] add support for sampling
124 | - [x] add date parser from other columns
125 | - [x] add date parser from string
126 |
--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-midnight
2 |
--------------------------------------------------------------------------------
/docs/assets/github-jalali-pandas.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ghodsizadeh/jalali-pandas/ce480829a3c50a53cb2a17c94e5a49648d18ca42/docs/assets/github-jalali-pandas.png
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | [](http://hits.dwyl.com/ghodsizadeh/jalali-pandas)
2 | 
3 | [](https://badge.fury.io/py/jalali-pandas)
4 | [](https://github.com/python/black)
5 | [](https://codecov.io/gh/ghodsizadeh/jalali-pandas)
6 | [](https://www.gnu.org/licenses/gpl-3.0)
7 | [](https://colab.research.google.com/github/ghodsizadeh/jalali-pandas/blob/main/examples/basic_usage.ipynb)
8 | 
9 |
10 | # Jalali Pandas Extentsion
11 |
12 | > A pandas extension that solves all problems of Jalai/Iraninan/Shamsi dates
13 |
14 | 
15 |
16 | ## Features
17 |
18 | #### Series Extenstion
19 |
20 | - Convert _string_ to _Jalali_ date `1388/03/25` --> `jdatetime(1388,3,25,0,0)`
21 | - Convert _gregorian_ date to _Jalali_ date `datetime(2019,11,17,0,0)` --> `jdatetime(1398,8,26,0,0)`
22 | - Convert _Jalali_ date to _gregorian_ date `jdatetime(1398,10,18,0,0)` --> `datetim(2020,1,8,6,19)`
23 |
24 | #### DataFrame extenstion
25 |
26 | - Support grouping by _Jalali_ date
27 | - Group by year, month, days, ...
28 | - Shortcuts for groups: `ymd` for `['year','month','day']` and more
29 | - Resampling: Convenience method for frequency conversion and resampling of time series but in _Jalali_ dateformat. (comming soon)
30 |
31 | ## Installation
32 |
33 | pip install -U jalali-pandas
34 |
35 | ## Usage
36 |
37 | Just import jalali-pandas and use pandas just use `.jalali` as a method for series and dataframes. Nothin outside pandas.
38 |
39 | > `jalali-pandas` is an extentsion for pandas, that add a mehtod for series/columns and dataframes.
40 |
41 | ### Series
42 |
43 | ```python
44 | import pandas as pd
45 | import jalali_pandas
46 |
47 | # create dataframe
48 | df = pd.DataFrame({"date": pd.date_range("2019-01-01", periods=10, freq="D")})
49 |
50 | # convert to jalali
51 | df["jdate"] = df["date"].jalali.to_jalali()
52 |
53 | # convert to gregorian
54 | df["gdate"] = df["jdate"].jalali.to_gregorian()
55 |
56 | # parse string to jalali
57 | df1 = pd.DataFrame({"date": ["1399/08/02", "1399/08/03", "1399/08/04"]})
58 | df1["jdate"] = df1["date"].jalali.parse_jalali("%Y/%m/%d")
59 |
60 |
61 | # get access to jalali year,quarter ,month, day and weekday
62 | df['year'] = df["jdate"].jalali.year
63 | df['month'] = df["jdate"].jalali.month
64 | df['quarter'] = df["jdate"].jalali.quarter
65 | df['day'] = df["jdate"].jalali.day
66 | df['weekday'] = df["jdate"].jalali.weekday
67 |
68 | ```
69 |
70 | ### DataFrame
71 |
72 | ```python
73 |
74 | import pandas as pd
75 | import jalali_pandas
76 |
77 | df = pd.DataFrame(
78 | {
79 | "date": pd.date_range("2019-01-01", periods=10, freq="M"),
80 | "value": range(10),
81 | }
82 | )
83 | # make sure to create a column with jalali datetime format. (you can use any name)
84 | df["jdate"] = df["date"].jalali.to_jalali()
85 |
86 |
87 | # group by jalali year
88 | gp = df.jalali.groupby("year")
89 | gp.sum()
90 |
91 | #group by month
92 | mean = df.jalali.groupby('mean')
93 |
94 | #groupby year and month and day
95 | mean = df.jalali.groupby('ymd')
96 | # or
97 | mean = df.jalali.groupby(['year','month','day'])
98 |
99 |
100 | #groupby year and quarter
101 | mean = df.jalali.groupby('yq')
102 | # or
103 | mean = df.jalali.groupby(['year','quarter'])
104 | ```
105 |
106 | ---
107 |
108 | # راهنمای فارسی
109 |
110 | برای مطالعه راهنمای فارسی استفاده از کتابخانه به این آدرس مراجعه کنید.
111 |
112 | [معرفی بسته pandas-jalali | آموزش کار با تاریخ شمسی در pandas](https://learnwithmehdi.ir/posts/jalali-pandas/)
113 |
114 | ## راهنمای ویدیویی
115 |
116 | [](https://www.youtube.com/watch?v=PYS4Hxmzbyg)
117 |
--------------------------------------------------------------------------------
/examples/basic_usage.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "markdown",
5 | "metadata": {},
6 | "source": [
7 | "[](https://colab.research.google.com/github/ghodsizadeh/jalali-pandas/blob/main/examples/basic_usage.ipynb)\n",
8 | ""
9 | ]
10 | },
11 | {
12 | "cell_type": "code",
13 | "execution_count": 1,
14 | "metadata": {
15 | "colab": {
16 | "base_uri": "https://localhost:8080/"
17 | },
18 | "id": "2Q0mm14pq6Vl",
19 | "outputId": "c141b374-74e2-4b43-cac3-12e730283e28"
20 | },
21 | "outputs": [
22 | {
23 | "name": "stdout",
24 | "output_type": "stream",
25 | "text": [
26 | "Requirement already satisfied: jalali-pandas in /usr/local/lib/python3.7/dist-packages (0.1.1)\n",
27 | "Requirement already satisfied: jdatetime<4.0.0,>=3.6.4 in /usr/local/lib/python3.7/dist-packages (from jalali-pandas) (3.6.4)\n"
28 | ]
29 | }
30 | ],
31 | "source": [
32 | "%pip install jalali-pandas"
33 | ]
34 | },
35 | {
36 | "cell_type": "code",
37 | "execution_count": 9,
38 | "metadata": {
39 | "id": "4SdQuawtwDav"
40 | },
41 | "outputs": [],
42 | "source": [
43 | "import pandas as pd\n",
44 | "import jalali_pandas"
45 | ]
46 | },
47 | {
48 | "cell_type": "code",
49 | "execution_count": 10,
50 | "metadata": {
51 | "id": "iAa-llPyzFqe"
52 | },
53 | "outputs": [],
54 | "source": [
55 | "df = pd.DataFrame({\"date\": pd.date_range(\"2019-01-01\", periods=10, freq=\"D\")})"
56 | ]
57 | },
58 | {
59 | "cell_type": "markdown",
60 | "metadata": {
61 | "id": "bLP3LfwRz6Yf"
62 | },
63 | "source": [
64 | "# Working with Series"
65 | ]
66 | },
67 | {
68 | "cell_type": "code",
69 | "execution_count": 11,
70 | "metadata": {
71 | "colab": {
72 | "base_uri": "https://localhost:8080/",
73 | "height": 111
74 | },
75 | "id": "bYB97cjm0AHN",
76 | "outputId": "15738f62-344f-424e-b143-d232dad944b3"
77 | },
78 | "outputs": [
79 | {
80 | "data": {
81 | "text/html": [
82 | "\n",
83 | "\n",
96 | "
\n",
97 | " \n",
98 | " \n",
99 | " | \n",
100 | " date | \n",
101 | " jdate | \n",
102 | "
\n",
103 | " \n",
104 | " \n",
105 | " \n",
106 | " | 0 | \n",
107 | " 2019-01-01 | \n",
108 | " 1397-10-11 00:00:00 | \n",
109 | "
\n",
110 | " \n",
111 | " | 1 | \n",
112 | " 2019-01-02 | \n",
113 | " 1397-10-12 00:00:00 | \n",
114 | "
\n",
115 | " \n",
116 | "
\n",
117 | "
\n",
226 | "\n",
239 | "
\n",
240 | " \n",
241 | " \n",
242 | " | \n",
243 | " value | \n",
244 | "
\n",
245 | " \n",
246 | " | __year | \n",
247 | " | \n",
248 | "
\n",
249 | " \n",
250 | " \n",
251 | " \n",
252 | " | 1397 | \n",
253 | " 1 | \n",
254 | "
\n",
255 | " \n",
256 | " | 1398 | \n",
257 | " 44 | \n",
258 | "
\n",
259 | " \n",
260 | "
\n",
261 | "
\n",
308 | "\n",
321 | "
\n",
322 | " \n",
323 | " \n",
324 | " | \n",
325 | " | \n",
326 | " | \n",
327 | " value | \n",
328 | "
\n",
329 | " \n",
330 | " | __year | \n",
331 | " __month | \n",
332 | " __day | \n",
333 | " | \n",
334 | "
\n",
335 | " \n",
336 | " \n",
337 | " \n",
338 | " | 1397 | \n",
339 | " 11 | \n",
340 | " 11 | \n",
341 | " 0 | \n",
342 | "
\n",
343 | " \n",
344 | " | 12 | \n",
345 | " 9 | \n",
346 | " 1 | \n",
347 | "
\n",
348 | " \n",
349 | " | 1398 | \n",
350 | " 1 | \n",
351 | " 11 | \n",
352 | " 2 | \n",
353 | "
\n",
354 | " \n",
355 | " | 2 | \n",
356 | " 10 | \n",
357 | " 3 | \n",
358 | "
\n",
359 | " \n",
360 | " | 3 | \n",
361 | " 10 | \n",
362 | " 4 | \n",
363 | "
\n",
364 | " \n",
365 | " | 4 | \n",
366 | " 9 | \n",
367 | " 5 | \n",
368 | "
\n",
369 | " \n",
370 | " | 5 | \n",
371 | " 9 | \n",
372 | " 6 | \n",
373 | "
\n",
374 | " \n",
375 | " | 6 | \n",
376 | " 9 | \n",
377 | " 7 | \n",
378 | "
\n",
379 | " \n",
380 | " | 7 | \n",
381 | " 8 | \n",
382 | " 8 | \n",
383 | "
\n",
384 | " \n",
385 | " | 8 | \n",
386 | " 9 | \n",
387 | " 9 | \n",
388 | "
\n",
389 | " \n",
390 | "
\n",
391 | "
\n",
434 | "\n",
447 | "
\n",
448 | " \n",
449 | " \n",
450 | " | \n",
451 | " | \n",
452 | " value | \n",
453 | "
\n",
454 | " \n",
455 | " | __year | \n",
456 | " __quarter | \n",
457 | " | \n",
458 | "
\n",
459 | " \n",
460 | " \n",
461 | " \n",
462 | " | 1397 | \n",
463 | " 4 | \n",
464 | " 0.5 | \n",
465 | "
\n",
466 | " \n",
467 | " | 1398 | \n",
468 | " 1 | \n",
469 | " 3.0 | \n",
470 | "
\n",
471 | " \n",
472 | " | 2 | \n",
473 | " 6.0 | \n",
474 | "
\n",
475 | " \n",
476 | " | 3 | \n",
477 | " 8.5 | \n",
478 | "
\n",
479 | " \n",
480 | "
\n",
481 | "