[](https://pypi.org/project/pyinvestingsnippets/)
[](https://github.com/investingsnippets/pyinvestingsnippets/actions?query=workflow%3ACI)
[](https://pyinvestingsnippets.readthedocs.io/en/latest/?badge=latest)
# Python Module for Investing Snippets
Pandas extensions and utility classes for stock and investment analysis.
## Installation
```bash
pip install pyinvestingsnippets
```
## Examples and Documentation
Please see detailed examples under the `examples` directory and read the documentation [here](https://pyinvestingsnippets.readthedocs.io/en/latest/)
## Develop
First install the required venv and tox
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install tox
```
> On osx with Big Sur there is an [issue](https://github.com/numpy/numpy/issues/17784) with installing cython! Due to that, you can `docker run --rm -v $(PWD):/app --workdir=/app -it --entrypoint=sh python:3.8`
Run tox test and lint
```bash
tox
```
Install the package locally
```bash
pip install .tox/dist/pyinvestingsnippets-<version>.zip
```
## Run examples
```bash
python3 -m venv .venvtest
source .venvtest/bin/activate
pip install -r requirements.txt
pip install -r examples/requirements.txt
python examples/matplotlib_report.py
```
> If on OSX set env var to `OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES`
## Release
On master change the version in `pyinvestingsnippets/__init__.py`
```bash
git commit -am "v<VERSION>"
git tag -a v0.0.3
git push origin --tags
git push -u
tox -e release
```
Raw data
{
"_id": null,
"home_page": "https://pyinvestingsnippets.readthedocs.io/",
"name": "pyinvestingsnippets",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "investing,financial-data,pandas",
"author": "InvestingSnippets",
"author_email": "investingsnippets@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2e/4b/a18651bdb54b4fbc871f1940ffb818c3fa7e73711662e182866f78a28162/pyinvestingsnippets-4.0.1.tar.gz",
"platform": null,
"description": "\n\n[](https://pypi.org/project/pyinvestingsnippets/)\n\n[](https://github.com/investingsnippets/pyinvestingsnippets/actions?query=workflow%3ACI)\n\n[](https://pyinvestingsnippets.readthedocs.io/en/latest/?badge=latest)\n\n\n# Python Module for Investing Snippets\n\nPandas extensions and utility classes for stock and investment analysis.\n\n\n## Installation\n\n```bash\npip install pyinvestingsnippets\n```\n\n## Examples and Documentation\n\nPlease see detailed examples under the `examples` directory and read the documentation [here](https://pyinvestingsnippets.readthedocs.io/en/latest/)\n\n## Develop\n\nFirst install the required venv and tox\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip install tox\n```\n\n> On osx with Big Sur there is an [issue](https://github.com/numpy/numpy/issues/17784) with installing cython! Due to that, you can `docker run --rm -v $(PWD):/app --workdir=/app -it --entrypoint=sh python:3.8`\n\nRun tox test and lint\n\n```bash\ntox\n```\n\nInstall the package locally\n\n```bash\npip install .tox/dist/pyinvestingsnippets-<version>.zip\n```\n\n## Run examples\n\n```bash\npython3 -m venv .venvtest\nsource .venvtest/bin/activate\npip install -r requirements.txt\npip install -r examples/requirements.txt\npython examples/matplotlib_report.py\n```\n\n> If on OSX set env var to `OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES`\n\n## Release\n\nOn master change the version in `pyinvestingsnippets/__init__.py`\n\n```bash\ngit commit -am \"v<VERSION>\"\ngit tag -a v0.0.3\ngit push origin --tags\ngit push -u\ntox -e release\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "",
"version": "4.0.1",
"project_urls": {
"Bug Reports": "https://github.com/investingsnippets/pyinvestingsnippets/issues",
"Documentation": "https://pyinvestingsnippets.readthedocs.io/",
"Homepage": "https://pyinvestingsnippets.readthedocs.io/",
"Source": "https://github.com/investingsnippets/pyinvestingsnippets"
},
"split_keywords": [
"investing",
"financial-data",
"pandas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a678b591679057cf19c6cd6b43ebe66319521ecc66bbb5f4369f6e9ca953f77e",
"md5": "995b4452b2c33128139b86bbfd357b4c",
"sha256": "e64124de9e0c716729fd9def211e990a4ac7b98fe78d8d92791b38380e8863cd"
},
"downloads": -1,
"filename": "pyinvestingsnippets-4.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "995b4452b2c33128139b86bbfd357b4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 33188,
"upload_time": "2023-11-14T19:34:45",
"upload_time_iso_8601": "2023-11-14T19:34:45.889986Z",
"url": "https://files.pythonhosted.org/packages/a6/78/b591679057cf19c6cd6b43ebe66319521ecc66bbb5f4369f6e9ca953f77e/pyinvestingsnippets-4.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e4ba18651bdb54b4fbc871f1940ffb818c3fa7e73711662e182866f78a28162",
"md5": "37e0a19a478e82ad58dbb9d974614b5a",
"sha256": "1017b5bdb8d965bbf2dffb490f0f1cf5618b9591ba5fb818170099f6d472de91"
},
"downloads": -1,
"filename": "pyinvestingsnippets-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "37e0a19a478e82ad58dbb9d974614b5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14450,
"upload_time": "2023-11-14T19:34:47",
"upload_time_iso_8601": "2023-11-14T19:34:47.667855Z",
"url": "https://files.pythonhosted.org/packages/2e/4b/a18651bdb54b4fbc871f1940ffb818c3fa7e73711662e182866f78a28162/pyinvestingsnippets-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-14 19:34:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "investingsnippets",
"github_project": "pyinvestingsnippets",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "scikit-learn",
"specs": [
[
">=",
"1.0.2"
]
]
},
{
"name": "seaborn",
"specs": [
[
">=",
"0.11.2"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.5.1"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.7.3"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.3.5"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.21.5"
]
]
},
{
"name": "plotly",
"specs": [
[
">=",
"5.6.0"
]
]
}
],
"tox": true,
"lcname": "pyinvestingsnippets"
}
JSON
