# birdfeeder
Helper library for CoinAlpha projects
## Usage
The library is published to pypi as [birdfeeder-coinalpha](https://pypi.org/project/birdfeeder-coinalpha/)
### Installing
```
pip install birdfeeder-coinalpha
```
```
poetry add 'birdfeeder-coinalpha@^1'
```
### How to install old versions
In pyproject.toml:
```
birdfeeder-coinalpha = { git = "https://github.com/coinalpha/birdfeeder.git", branch = "master" }
birdfeeder-coinalpha = { git = "https://github.com/coinalpha/birdfeeder.git", rev = "29cdd7229d0d35a989322f5026382400d1332da4" }
birdfeeder-coinalpha = { git = "https://github.com/coinalpha/birdfeeder.git", tag = "0.1.0" }
```
pip:
```
git+https://github.com/coinalpha/birdfeeder.git@master#egg=birdfeeder
git+https://github.com/coinalpha/birdfeeder.git@29cdd7229d0d35a989322f5026382400d1332da4#egg=birdfeeder
git+https://github.com/coinalpha/birdfeeder.git@0.1.0#egg=birdfeeder
```
## Development
To install library for development in conda environment, run
```
./install
```
Alternativelly (preferred), you can use poetry env:
```
poetry install
poetry shell
```
## How to add a dependency
1. If you're running in conda, you need to install required package first.
1. Then, see installed version in `conda env export`
1. Take this version and add into pyproject.toml, into `[tool.poetry.dependencies]` (or dev section, if the package is needed for development only). Specify version (or range) according to [Dependency Specification](https://python-poetry.org/docs/dependency-specification/)
If using poetry:
1. Run `poetry add <package>`
## Releasing a new version
Idea: we're keeping own version and dependencies info in `pyproject.toml`, and then generating `setup.py` so that the library could be installed via tools like pip. We're also generating `environment.yml` file because we're mostly using conda to manage development environments at CoinAlpha.
1. Change version in `pyproject.toml` and `birdfeeder/__init__.py`
1. Generate `setup.py`: `dephell deps convert`
1. Generate `environment.yml`: `poetry2conda --dev pyproject.toml environment.yml`
1. Commit updates `git add -u && git commit`
1. Create git tag `x.y.z`: `git tag -s x.y.z`
1. Run `git push && git push --tags`
1. Publish to pypi: `poetry publish --build`
Raw data
{
"_id": null,
"home_page": "https://github.com/coinalpha/birdfeeder",
"name": "birdfeeder-coinalpha",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Vladimir Kamarzin",
"author_email": "vvk@vvk.pp.ru",
"download_url": "https://files.pythonhosted.org/packages/24/ae/9119c948e94fcc6860d2888303b268f43d537b1f24f3a1fdf0336f23ff97/birdfeeder_coinalpha-1.3.0.tar.gz",
"platform": null,
"description": "# birdfeeder\n\nHelper library for CoinAlpha projects\n\n## Usage\n\nThe library is published to pypi as [birdfeeder-coinalpha](https://pypi.org/project/birdfeeder-coinalpha/)\n\n### Installing\n\n```\npip install birdfeeder-coinalpha\n```\n\n```\npoetry add 'birdfeeder-coinalpha@^1'\n```\n\n\n### How to install old versions\n\nIn pyproject.toml:\n\n```\nbirdfeeder-coinalpha = { git = \"https://github.com/coinalpha/birdfeeder.git\", branch = \"master\" }\nbirdfeeder-coinalpha = { git = \"https://github.com/coinalpha/birdfeeder.git\", rev = \"29cdd7229d0d35a989322f5026382400d1332da4\" }\nbirdfeeder-coinalpha = { git = \"https://github.com/coinalpha/birdfeeder.git\", tag = \"0.1.0\" }\n```\n\npip:\n\n```\ngit+https://github.com/coinalpha/birdfeeder.git@master#egg=birdfeeder\ngit+https://github.com/coinalpha/birdfeeder.git@29cdd7229d0d35a989322f5026382400d1332da4#egg=birdfeeder\ngit+https://github.com/coinalpha/birdfeeder.git@0.1.0#egg=birdfeeder\n```\n\n\n## Development\n\nTo install library for development in conda environment, run\n\n```\n./install\n```\n\nAlternativelly (preferred), you can use poetry env:\n\n```\npoetry install\npoetry shell\n```\n\n## How to add a dependency\n\n1. If you're running in conda, you need to install required package first.\n1. Then, see installed version in `conda env export`\n1. Take this version and add into pyproject.toml, into `[tool.poetry.dependencies]` (or dev section, if the package is needed for development only). Specify version (or range) according to [Dependency Specification](https://python-poetry.org/docs/dependency-specification/)\n\nIf using poetry:\n\n1. Run `poetry add <package>`\n\n## Releasing a new version\n\nIdea: we're keeping own version and dependencies info in `pyproject.toml`, and then generating `setup.py` so that the library could be installed via tools like pip. We're also generating `environment.yml` file because we're mostly using conda to manage development environments at CoinAlpha.\n\n1. Change version in `pyproject.toml` and `birdfeeder/__init__.py`\n1. Generate `setup.py`: `dephell deps convert`\n1. Generate `environment.yml`: `poetry2conda --dev pyproject.toml environment.yml`\n1. Commit updates `git add -u && git commit`\n1. Create git tag `x.y.z`: `git tag -s x.y.z`\n1. Run `git push && git push --tags`\n1. Publish to pypi: `poetry publish --build`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helper library for CoinAlpha projects",
"version": "1.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0b4d9d35cb91cfcfab51a2feb2e4fa9f",
"sha256": "28346471f50c967a10041d74986113745547f8818d48adad90c1206e269cae01"
},
"downloads": -1,
"filename": "birdfeeder_coinalpha-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b4d9d35cb91cfcfab51a2feb2e4fa9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 28926,
"upload_time": "2022-12-01T14:43:53",
"upload_time_iso_8601": "2022-12-01T14:43:53.592586Z",
"url": "https://files.pythonhosted.org/packages/3c/72/3a74593f13021506e00f06728e4d25b41345ec21b82e1dad064ed0ad72eb/birdfeeder_coinalpha-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f781a84d9a7e40d89392d83166f4439f",
"sha256": "90c09f387ad8ab4192dabf62ff5e4eac4cf97cf84831164130c1b96eb85531d3"
},
"downloads": -1,
"filename": "birdfeeder_coinalpha-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "f781a84d9a7e40d89392d83166f4439f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 23590,
"upload_time": "2022-12-01T14:43:54",
"upload_time_iso_8601": "2022-12-01T14:43:54.969561Z",
"url": "https://files.pythonhosted.org/packages/24/ae/9119c948e94fcc6860d2888303b268f43d537b1f24f3a1fdf0336f23ff97/birdfeeder_coinalpha-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-01 14:43:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "coinalpha",
"github_project": "birdfeeder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "birdfeeder-coinalpha"
}
JSON
