# satsync
[](https://img.shields.io/github/v/release/csaybar/satsync)
[](https://github.com/csaybar/satsync/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/csaybar/satsync)
[](https://img.shields.io/github/commit-activity/m/csaybar/satsync)
[](https://img.shields.io/github/license/csaybar/satsync)
A python package to align satellite images.
- **Github repository**: <https://github.com/csaybar/satsync/>
- **Documentation** <https://csaybar.github.io/satsync/>
## Getting started with your project
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:csaybar/satsync.git
git push -u origin main
```
Finally, install the environment and the pre-commit hooks with
```bash
make install
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
## Releasing a new version
- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/csaybar/satsync/settings/secrets/actions/new).
- Create a [new release](https://github.com/csaybar/satsync/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
Raw data
{
"_id": null,
"home_page": "https://github.com/csaybar/satsync",
"name": "satsync",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Cesar Aybar",
"author_email": "fcesar.aybar@uv.es",
"download_url": "https://files.pythonhosted.org/packages/c6/6f/3175e06271acd58d7627ed99b5ae37d6da4e05972a093dcb2916e648ce5e/satsync-0.0.6.tar.gz",
"platform": null,
"description": "# satsync\n\n[](https://img.shields.io/github/v/release/csaybar/satsync)\n[](https://github.com/csaybar/satsync/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/csaybar/satsync)\n[](https://img.shields.io/github/commit-activity/m/csaybar/satsync)\n[](https://img.shields.io/github/license/csaybar/satsync)\n\nA python package to align satellite images.\n\n- **Github repository**: <https://github.com/csaybar/satsync/>\n- **Documentation** <https://csaybar.github.io/satsync/>\n\n## Getting started with your project\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:csaybar/satsync.git\ngit push -u origin main\n```\n\nFinally, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [Pypi](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/csaybar/satsync/settings/secrets/actions/new).\n- Create a [new release](https://github.com/csaybar/satsync/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A python package to align satellite images.",
"version": "0.0.6",
"project_urls": {
"Documentation": "https://csaybar.github.io/satsync/",
"Homepage": "https://github.com/csaybar/satsync",
"Repository": "https://github.com/csaybar/satsync"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc5d1ac522b4c5ae947646ea73b6042054575fcbab8b81f69cd303922d7b0647",
"md5": "5f08a82570d440fc9326cbd2196aed3b",
"sha256": "40b34dd2060d948c7ef72e3e17287c4afd077ec574fcc49fdea2dfcf59b9927f"
},
"downloads": -1,
"filename": "satsync-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f08a82570d440fc9326cbd2196aed3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 41078,
"upload_time": "2024-05-06T09:44:23",
"upload_time_iso_8601": "2024-05-06T09:44:23.055972Z",
"url": "https://files.pythonhosted.org/packages/bc/5d/1ac522b4c5ae947646ea73b6042054575fcbab8b81f69cd303922d7b0647/satsync-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c66f3175e06271acd58d7627ed99b5ae37d6da4e05972a093dcb2916e648ce5e",
"md5": "078999219ff79a442bd7ca2df463fc20",
"sha256": "ba02a9a8b2472a8fe3a07694912c4ed33297552017084c34273abb4b7261eaf7"
},
"downloads": -1,
"filename": "satsync-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "078999219ff79a442bd7ca2df463fc20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 36508,
"upload_time": "2024-05-06T09:44:24",
"upload_time_iso_8601": "2024-05-06T09:44:24.833023Z",
"url": "https://files.pythonhosted.org/packages/c6/6f/3175e06271acd58d7627ed99b5ae37d6da4e05972a093dcb2916e648ce5e/satsync-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 09:44:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csaybar",
"github_project": "satsync",
"github_not_found": true,
"lcname": "satsync"
}
JSON
