pip-project-template


Namepip-project-template JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA Python project template for a pip package with MCP server support and agentic coding workflows (planning + test-driven development)
upload_time2025-08-27 00:53:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords vibe coding ai agent mcp planning test-driven development tdd template testing coverage
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!-- ---
!-- Timestamp: 2025-08-27 10:52:15
!-- Author: ywatanabe
!-- File: /home/ywatanabe/proj/pip-project-template/README.md
!-- --- -->

# Pip Project Template

A Python project template for a pip package, featuring **FastMCP 2.0** servers for agentic coding workflows (planning + test-driven development).

[![CI](https://github.com/ywatanabe1989/pip-project-template/workflows/Validation/badge.svg)](https://github.com/ywatanabe1989/pip-project-template/actions)
[![codecov](https://codecov.io/gh/ywatanabe1989/pip-project-template/branch/develop/graph/badge.svg)](https://codecov.io/gh/ywatanabe1989/pip-project-template)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![FastMCP](https://img.shields.io/badge/FastMCP-2.0-green.svg)](https://gofastmcp.com)

## Quick Start

[Makefile](./Makefile), which defines commands, is the entry point.

```bash
# Installation
make install          # Install project dependencies (or pip install -e .)
                       
# Tests
make test-changed     # Run tests which affected by source code change (fast)
make test-full        # Run full tests with coverage
make coverage-html    # Generate HTML coverage report
make ci-act           # Run GitHub Actions locally with Act and Apptainer
make ci-container     # Run CI with containers (Apptainer -> Docker fallback)
make ci-local         # Run local CI emulator (Python-based)
make lint             # Run linting and formatting

# Publish as a pip package in PyPI repository
make build            # Build package for distribution
make upload-pypi-test # Upload to Test PyPI
make upload-pypi      # Upload to PyPI
make release          # Clean, build, and upload to PyPI

# Maintainance
make clean            # Remove cache files
```

## Python API

```bash
python -m pip_project_template calculate 10 5
python -m pip_project_template serve01
python -m pip_project_template info
```

## MCP Servers
<details>

``` json
{
  "mcpServers": {
    "calculator-basic": {
      "command": "python",
      "args": ["-m", "pip_project_template", "serve01", "--transport", "stdio"],
      "env": {
        "PYTHONPATH": "."
      }
    },
    "calculator-enhanced": {
      "command": "python", 
      "args": ["-m", "pip_project_template", "serve02", "--transport", "stdio"],
      "env": {
        "PYTHONPATH": "."
      }
    },
    "http-calculator": {
      "url": "http://localhost:8081/mcp",
      "transport": "http"
    },
    "sse-calculator": {
      "url": "http://localhost:8082",
      "transport": "sse"
    }
  },
  "defaults": {
    "timeout": 30,
    "retries": 3
  },
  "logging": {
    "level": "INFO",
    "file": "logs/mcp.log"
  }
}
```

</details>
## Project Structure

```
src/pip_project_template/    # Source code
tests/custom                 # Custom Tests
tests/github_actions         # Scripts for running GitHub Actions locally
tests/pip_project_template/  # Tests for source code (1-on-1 relationship)
tests/reports                # Test results
data/                        # For persistent data
config/mcp_config.json       # MCP configuration
mgmt/                        # Project Management and Agent Definitions
```

## Requirements

Python 3.11+

## License

MIT

## Contact
Yusuke.Watanabe@scitex.ai

<!-- EOF -->

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pip-project-template",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Yusuke Watanabe <Yusuke.Watanabe@scitex.ai>",
    "keywords": "vibe coding, AI agent, mcp, planning, test-driven development, TDD, template, testing, coverage",
    "author": null,
    "author_email": "Yusuke Watanabe <Yusuke.Watanabe@scitex.ai>",
    "download_url": "https://files.pythonhosted.org/packages/a8/e2/84fe9a633c1a4f512709ded3d89341a962250ea3a0b82a8cbe6c3198bd55/pip_project_template-0.1.0.tar.gz",
    "platform": null,
    "description": "<!-- ---\n!-- Timestamp: 2025-08-27 10:52:15\n!-- Author: ywatanabe\n!-- File: /home/ywatanabe/proj/pip-project-template/README.md\n!-- --- -->\n\n# Pip Project Template\n\nA Python project template for a pip package, featuring **FastMCP 2.0** servers for agentic coding workflows (planning + test-driven development).\n\n[![CI](https://github.com/ywatanabe1989/pip-project-template/workflows/Validation/badge.svg)](https://github.com/ywatanabe1989/pip-project-template/actions)\n[![codecov](https://codecov.io/gh/ywatanabe1989/pip-project-template/branch/develop/graph/badge.svg)](https://codecov.io/gh/ywatanabe1989/pip-project-template)\n[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)\n[![FastMCP](https://img.shields.io/badge/FastMCP-2.0-green.svg)](https://gofastmcp.com)\n\n## Quick Start\n\n[Makefile](./Makefile), which defines commands, is the entry point.\n\n```bash\n# Installation\nmake install          # Install project dependencies (or pip install -e .)\n                       \n# Tests\nmake test-changed     # Run tests which affected by source code change (fast)\nmake test-full        # Run full tests with coverage\nmake coverage-html    # Generate HTML coverage report\nmake ci-act           # Run GitHub Actions locally with Act and Apptainer\nmake ci-container     # Run CI with containers (Apptainer -> Docker fallback)\nmake ci-local         # Run local CI emulator (Python-based)\nmake lint             # Run linting and formatting\n\n# Publish as a pip package in PyPI repository\nmake build            # Build package for distribution\nmake upload-pypi-test # Upload to Test PyPI\nmake upload-pypi      # Upload to PyPI\nmake release          # Clean, build, and upload to PyPI\n\n# Maintainance\nmake clean            # Remove cache files\n```\n\n## Python API\n\n```bash\npython -m pip_project_template calculate 10 5\npython -m pip_project_template serve01\npython -m pip_project_template info\n```\n\n## MCP Servers\n<details>\n\n``` json\n{\n  \"mcpServers\": {\n    \"calculator-basic\": {\n      \"command\": \"python\",\n      \"args\": [\"-m\", \"pip_project_template\", \"serve01\", \"--transport\", \"stdio\"],\n      \"env\": {\n        \"PYTHONPATH\": \".\"\n      }\n    },\n    \"calculator-enhanced\": {\n      \"command\": \"python\", \n      \"args\": [\"-m\", \"pip_project_template\", \"serve02\", \"--transport\", \"stdio\"],\n      \"env\": {\n        \"PYTHONPATH\": \".\"\n      }\n    },\n    \"http-calculator\": {\n      \"url\": \"http://localhost:8081/mcp\",\n      \"transport\": \"http\"\n    },\n    \"sse-calculator\": {\n      \"url\": \"http://localhost:8082\",\n      \"transport\": \"sse\"\n    }\n  },\n  \"defaults\": {\n    \"timeout\": 30,\n    \"retries\": 3\n  },\n  \"logging\": {\n    \"level\": \"INFO\",\n    \"file\": \"logs/mcp.log\"\n  }\n}\n```\n\n</details>\n## Project Structure\n\n```\nsrc/pip_project_template/    # Source code\ntests/custom                 # Custom Tests\ntests/github_actions         # Scripts for running GitHub Actions locally\ntests/pip_project_template/  # Tests for source code (1-on-1 relationship)\ntests/reports                # Test results\ndata/                        # For persistent data\nconfig/mcp_config.json       # MCP configuration\nmgmt/                        # Project Management and Agent Definitions\n```\n\n## Requirements\n\nPython 3.11+\n\n## License\n\nMIT\n\n## Contact\nYusuke.Watanabe@scitex.ai\n\n<!-- EOF -->\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python project template for a pip package with MCP server support and agentic coding workflows (planning + test-driven development)",
    "version": "0.1.0",
    "project_urls": {
        "Documentation": "https://github.com/ywatanabe1989/pip-project-template",
        "Homepage": "https://github.com/ywatanabe1989/pip-project-template",
        "Repository": "https://github.com/ywatanabe1989/pip-project-template"
    },
    "split_keywords": [
        "vibe coding",
        " ai agent",
        " mcp",
        " planning",
        " test-driven development",
        " tdd",
        " template",
        " testing",
        " coverage"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4b7ab2464017adc8af4b6e8f1f6a350247556045a589c032cdf8a3bc52050ff4",
                "md5": "37588c94339a89db7070dc00fb9a86b8",
                "sha256": "f453976ee1beede61f84d76701b9a0b227328fa3194678882d6a0af2fcace338"
            },
            "downloads": -1,
            "filename": "pip_project_template-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "37588c94339a89db7070dc00fb9a86b8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 15161,
            "upload_time": "2025-08-27T00:53:40",
            "upload_time_iso_8601": "2025-08-27T00:53:40.557680Z",
            "url": "https://files.pythonhosted.org/packages/4b/7a/b2464017adc8af4b6e8f1f6a350247556045a589c032cdf8a3bc52050ff4/pip_project_template-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a8e284fe9a633c1a4f512709ded3d89341a962250ea3a0b82a8cbe6c3198bd55",
                "md5": "1f9297dd8367c45063d5fa86167a1ea8",
                "sha256": "3e6ee93f243c0b210b6c11e69e8ca75e8972e19ee5a41570b57964b84af9154d"
            },
            "downloads": -1,
            "filename": "pip_project_template-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1f9297dd8367c45063d5fa86167a1ea8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 11063,
            "upload_time": "2025-08-27T00:53:42",
            "upload_time_iso_8601": "2025-08-27T00:53:42.260804Z",
            "url": "https://files.pythonhosted.org/packages/a8/e2/84fe9a633c1a4f512709ded3d89341a962250ea3a0b82a8cbe6c3198bd55/pip_project_template-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-27 00:53:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ywatanabe1989",
    "github_project": "pip-project-template",
    "github_not_found": true,
    "lcname": "pip-project-template"
}
        
Elapsed time: 1.62884s