seed-farmer


Nameseed-farmer JSON
Version 7.0.2 PyPI version JSON
download
home_pageNone
SummaryThe AWS Professional Services CLI tool SeedFarmer for GitOps support
upload_time2025-07-09 15:50:44
maintainerNone
docs_urlNone
authorAWS Professional Services
requires_python<3.14,>=3.9
licenseApache-2.0
keywords aws gitops
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Seed-Farmer

[![PyPi](https://img.shields.io/pypi/v/seed-farmer)](https://pypi.org/project/seed-farmer/)
[![Python Version](https://img.shields.io/pypi/pyversions/seed-farmer.svg)](https://pypi.org/project/seed-farmer/)
[![License](https://img.shields.io/pypi/l/seed-farmer)](https://github.com/awslabs/seed-farmer/blob/main/LICENSE)

Seed-Farmer (seedfarmer) is an opensource orchestration tool that works with AWS CodeSeeder (see [github](https://github.com/awslabs/aws-codeseeder) or [docs](https://aws-codeseeder.readthedocs.io/en/latest/)) and acts as an orchestration tool modeled after [GitOps deployments](https://www.gitops.tech/).  It has a CommandLine Interface (CLI) based in Python. 

Please see our [SeedFarmer Documentation](https://seed-farmer.readthedocs.io/en/latest/).

For information related to the architecture of Seed-Farmer or the deployment scheme...please see:
- [Seed-Farmer multi-account architecture](https://seed-farmer.readthedocs.io/en/latest/architecture.html)
- [Seed-Farmer processing steps](https://seed-farmer.readthedocs.io/en/latest/architecture.html#method-of-processing)

Seed-Farmer uses modular code deployments ([see modules](https://seed-farmer.readthedocs.io/en/latest/module_development.html)) leveraging [manifests](https://seed-farmer.readthedocs.io/en/latest/manifests.html) and [deployspecs](https://seed-farmer.readthedocs.io/en/latest/module_development.html#deployspec), keeping track of changes and applying changes as need / detected.


## Getting Started
The Seed-Farmer library is available on PyPi.  Install the library in a python virtual environment.


```bash
python3 -m venv .venv
source .venv/bin/activate
pip install seed-farmer
```

A [project](https://seed-farmer.readthedocs.io/en/latest/project_development.html) is now necessary to begin create modules.  

## Development

To get started with developing you need to setup a virtual environment and install the needed python dependencies

Setup virtual environment and install dependencies:

```bash
make install
```

Run unit tests
```bash
make test
```

Validate ruff formatting and mypy
```bash
make validate
```

Fix ruff formatting issues
```bash
make format
```
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "seed-farmer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.9",
    "maintainer_email": null,
    "keywords": "AWS, GitOps",
    "author": "AWS Professional Services",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/68/63/7794d405ea15c42b0d0d95bba8bd99ef0969664795c4d69235bce41ac874/seed_farmer-7.0.2.tar.gz",
    "platform": null,
    "description": "# Seed-Farmer\n\n[![PyPi](https://img.shields.io/pypi/v/seed-farmer)](https://pypi.org/project/seed-farmer/)\n[![Python Version](https://img.shields.io/pypi/pyversions/seed-farmer.svg)](https://pypi.org/project/seed-farmer/)\n[![License](https://img.shields.io/pypi/l/seed-farmer)](https://github.com/awslabs/seed-farmer/blob/main/LICENSE)\n\nSeed-Farmer (seedfarmer) is an opensource orchestration tool that works with AWS CodeSeeder (see [github](https://github.com/awslabs/aws-codeseeder) or [docs](https://aws-codeseeder.readthedocs.io/en/latest/)) and acts as an orchestration tool modeled after [GitOps deployments](https://www.gitops.tech/).  It has a CommandLine Interface (CLI) based in Python. \n\nPlease see our [SeedFarmer Documentation](https://seed-farmer.readthedocs.io/en/latest/).\n\nFor information related to the architecture of Seed-Farmer or the deployment scheme...please see:\n- [Seed-Farmer multi-account architecture](https://seed-farmer.readthedocs.io/en/latest/architecture.html)\n- [Seed-Farmer processing steps](https://seed-farmer.readthedocs.io/en/latest/architecture.html#method-of-processing)\n\nSeed-Farmer uses modular code deployments ([see modules](https://seed-farmer.readthedocs.io/en/latest/module_development.html)) leveraging [manifests](https://seed-farmer.readthedocs.io/en/latest/manifests.html) and [deployspecs](https://seed-farmer.readthedocs.io/en/latest/module_development.html#deployspec), keeping track of changes and applying changes as need / detected.\n\n\n## Getting Started\nThe Seed-Farmer library is available on PyPi.  Install the library in a python virtual environment.\n\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip install seed-farmer\n```\n\nA [project](https://seed-farmer.readthedocs.io/en/latest/project_development.html) is now necessary to begin create modules.  \n\n## Development\n\nTo get started with developing you need to setup a virtual environment and install the needed python dependencies\n\nSetup virtual environment and install dependencies:\n\n```bash\nmake install\n```\n\nRun unit tests\n```bash\nmake test\n```\n\nValidate ruff formatting and mypy\n```bash\nmake validate\n```\n\nFix ruff formatting issues\n```bash\nmake format\n```",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "The AWS Professional Services CLI tool SeedFarmer for GitOps support",
    "version": "7.0.2",
    "project_urls": {
        "Homepage": "https://github.com/awslabs/seed-farmer",
        "Org Site": "https://aws.amazon.com/professional-services/"
    },
    "split_keywords": [
        "aws",
        " gitops"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "731b681a7f0819b4e7c05864ac8245c92046cbd125023bb1b59d93d6a8a35bf1",
                "md5": "29acadbc4e45965cf03e61b0f799a8d1",
                "sha256": "d518e63639aadcec7fa9b228e36924e3c358849baea4713db924fee362dc2483"
            },
            "downloads": -1,
            "filename": "seed_farmer-7.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29acadbc4e45965cf03e61b0f799a8d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.9",
            "size": 157874,
            "upload_time": "2025-07-09T15:50:43",
            "upload_time_iso_8601": "2025-07-09T15:50:43.621544Z",
            "url": "https://files.pythonhosted.org/packages/73/1b/681a7f0819b4e7c05864ac8245c92046cbd125023bb1b59d93d6a8a35bf1/seed_farmer-7.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "68637794d405ea15c42b0d0d95bba8bd99ef0969664795c4d69235bce41ac874",
                "md5": "28138d9904814e616496e00fed445ce2",
                "sha256": "b9021c66d378d309a747159495efb7eaf01459675280beb2a3054410a5aa600f"
            },
            "downloads": -1,
            "filename": "seed_farmer-7.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "28138d9904814e616496e00fed445ce2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.9",
            "size": 101135,
            "upload_time": "2025-07-09T15:50:44",
            "upload_time_iso_8601": "2025-07-09T15:50:44.675573Z",
            "url": "https://files.pythonhosted.org/packages/68/63/7794d405ea15c42b0d0d95bba8bd99ef0969664795c4d69235bce41ac874/seed_farmer-7.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 15:50:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "awslabs",
    "github_project": "seed-farmer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "seed-farmer"
}
        
Elapsed time: 0.40630s