learning-pypi-demo-nisimi


Namelearning-pypi-demo-nisimi JSON
Version 0.1.5 PyPI version JSON
download
home_pagehttps://github.com/nisimi/learning-pypi-demo-nisimi
SummaryEducational Python package to demonstrate PyPI publishing process
upload_time2025-09-03 15:13:30
maintainerNone
docs_urlNone
authornisimi
requires_python>=3.7
licenseMIT
keywords education pypi demo learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # learning-pypi-demo-nisimi

[![PyPI version](https://badge.fury.io/py/learning-pypi-demo-nisimi.svg)](https://badge.fury.io/py/learning-pypi-demo-nisimi)
[![Python Version](https://img.shields.io/pypi/pyversions/learning-pypi-demo-nisimi.svg)](https://pypi.org/project/learning-pypi-demo-nisimi/)

An educational Python package to demonstrate the PyPI publishing process. This package serves as a learning tool for understanding how to create, build, and publish Python packages to the Python Package Index (PyPI).

## Features

- **Installation Message**: Displays "HELLO NEW PACKAGE" during pip installation
- **Simple API**: Includes a basic `hello()` function for demonstration
- **Hash-based Installation**: Supports secure installation via `pip install -r requirements.txt --require-hashes`
- **Educational Purpose**: Minimal codebase designed for learning PyPI publishing

## Installation

### Standard Installation

```bash
pip install learning-pypi-demo-nisimi
```

### Hash-verified Installation

For secure, hash-verified installation:

```bash
pip install -r requirements.txt --require-hashes
```

## Usage

```python
from learning_pypi_demo_nisimi import hello

# Basic usage
print(hello())
# Output: Hello, World! This is learning-pypi-demo-nisimi package.

# Personalized greeting
print(hello("Alice"))
# Output: Hello, Alice! This is learning-pypi-demo-nisimi package.
```

## Package Structure

```
learning-pypi-demo-nisimi/
├── learning_pypi_demo_nisimi/
│   ├── __init__.py          # Package initialization
│   └── core.py              # Core functionality
├── setup.py                 # Setup configuration with custom install
├── pyproject.toml          # Modern Python packaging configuration
├── requirements.txt        # Hash-verified requirements
├── README.md              # This file
├── LICENSE                # MIT License
└── MANIFEST.in           # Additional files for distribution
```

## Development

This package is designed as an educational tool for learning PyPI publishing. The custom installation message demonstrates how to extend the standard pip installation process.

### Building the Package

```bash
python -m build
```

### Publishing to PyPI

```bash
twine upload dist/*
```

## Educational Value

This package demonstrates:

- Custom installation commands in setup.py
- Modern packaging with pyproject.toml
- Hash-based dependency management
- Proper package structure and documentation
- PyPI publishing workflow

## Requirements

- Python 3.7 or higher
- No external dependencies (kept minimal for educational purposes)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

This is an educational package. Feel free to fork and experiment with your own versions to learn about PyPI publishing!

## Author

**nisimi**

## Acknowledgments

- Python Packaging Authority for excellent packaging documentation
- PyPI for providing the platform for package distribution

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nisimi/learning-pypi-demo-nisimi",
    "name": "learning-pypi-demo-nisimi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "education, pypi, demo, learning",
    "author": "nisimi",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/2b/5b/e5e17b2e2743f67ea9bb6ca602873782f92c0cb7e849bc1b9fdd88263e45/learning_pypi_demo_nisimi-0.1.5.tar.gz",
    "platform": null,
    "description": "# learning-pypi-demo-nisimi\n\n[![PyPI version](https://badge.fury.io/py/learning-pypi-demo-nisimi.svg)](https://badge.fury.io/py/learning-pypi-demo-nisimi)\n[![Python Version](https://img.shields.io/pypi/pyversions/learning-pypi-demo-nisimi.svg)](https://pypi.org/project/learning-pypi-demo-nisimi/)\n\nAn educational Python package to demonstrate the PyPI publishing process. This package serves as a learning tool for understanding how to create, build, and publish Python packages to the Python Package Index (PyPI).\n\n## Features\n\n- **Installation Message**: Displays \"HELLO NEW PACKAGE\" during pip installation\n- **Simple API**: Includes a basic `hello()` function for demonstration\n- **Hash-based Installation**: Supports secure installation via `pip install -r requirements.txt --require-hashes`\n- **Educational Purpose**: Minimal codebase designed for learning PyPI publishing\n\n## Installation\n\n### Standard Installation\n\n```bash\npip install learning-pypi-demo-nisimi\n```\n\n### Hash-verified Installation\n\nFor secure, hash-verified installation:\n\n```bash\npip install -r requirements.txt --require-hashes\n```\n\n## Usage\n\n```python\nfrom learning_pypi_demo_nisimi import hello\n\n# Basic usage\nprint(hello())\n# Output: Hello, World! This is learning-pypi-demo-nisimi package.\n\n# Personalized greeting\nprint(hello(\"Alice\"))\n# Output: Hello, Alice! This is learning-pypi-demo-nisimi package.\n```\n\n## Package Structure\n\n```\nlearning-pypi-demo-nisimi/\n\u251c\u2500\u2500 learning_pypi_demo_nisimi/\n\u2502   \u251c\u2500\u2500 __init__.py          # Package initialization\n\u2502   \u2514\u2500\u2500 core.py              # Core functionality\n\u251c\u2500\u2500 setup.py                 # Setup configuration with custom install\n\u251c\u2500\u2500 pyproject.toml          # Modern Python packaging configuration\n\u251c\u2500\u2500 requirements.txt        # Hash-verified requirements\n\u251c\u2500\u2500 README.md              # This file\n\u251c\u2500\u2500 LICENSE                # MIT License\n\u2514\u2500\u2500 MANIFEST.in           # Additional files for distribution\n```\n\n## Development\n\nThis package is designed as an educational tool for learning PyPI publishing. The custom installation message demonstrates how to extend the standard pip installation process.\n\n### Building the Package\n\n```bash\npython -m build\n```\n\n### Publishing to PyPI\n\n```bash\ntwine upload dist/*\n```\n\n## Educational Value\n\nThis package demonstrates:\n\n- Custom installation commands in setup.py\n- Modern packaging with pyproject.toml\n- Hash-based dependency management\n- Proper package structure and documentation\n- PyPI publishing workflow\n\n## Requirements\n\n- Python 3.7 or higher\n- No external dependencies (kept minimal for educational purposes)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nThis is an educational package. Feel free to fork and experiment with your own versions to learn about PyPI publishing!\n\n## Author\n\n**nisimi**\n\n## Acknowledgments\n\n- Python Packaging Authority for excellent packaging documentation\n- PyPI for providing the platform for package distribution\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Educational Python package to demonstrate PyPI publishing process",
    "version": "0.1.5",
    "project_urls": {
        "Bug Reports": "https://github.com/nisimi/learning-pypi-demo-nisimi/issues",
        "Homepage": "https://github.com/nisimi/learning-pypi-demo-nisimi",
        "Source": "https://github.com/nisimi/learning-pypi-demo-nisimi/"
    },
    "split_keywords": [
        "education",
        " pypi",
        " demo",
        " learning"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "98b338cd51ffc3b2e4ba4a8471f286f32dc89977e59cc20620529ab5d9851b91",
                "md5": "a74fc4f47b8de52893c1f69e76d89a32",
                "sha256": "7eb1405a3383b9de874b3cc77e5e76561fb18510ae99291ce70a66cb6e5a93ff"
            },
            "downloads": -1,
            "filename": "learning_pypi_demo_nisimi-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a74fc4f47b8de52893c1f69e76d89a32",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4257,
            "upload_time": "2025-09-03T15:13:29",
            "upload_time_iso_8601": "2025-09-03T15:13:29.350116Z",
            "url": "https://files.pythonhosted.org/packages/98/b3/38cd51ffc3b2e4ba4a8471f286f32dc89977e59cc20620529ab5d9851b91/learning_pypi_demo_nisimi-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2b5be5e17b2e2743f67ea9bb6ca602873782f92c0cb7e849bc1b9fdd88263e45",
                "md5": "c480c413f72a51379a5a51d069962a5d",
                "sha256": "39c6263cc15bfaca8b01f36e702af5675dd297901471f5db9d9b4337bc991654"
            },
            "downloads": -1,
            "filename": "learning_pypi_demo_nisimi-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "c480c413f72a51379a5a51d069962a5d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6113,
            "upload_time": "2025-09-03T15:13:30",
            "upload_time_iso_8601": "2025-09-03T15:13:30.546660Z",
            "url": "https://files.pythonhosted.org/packages/2b/5b/e5e17b2e2743f67ea9bb6ca602873782f92c0cb7e849bc1b9fdd88263e45/learning_pypi_demo_nisimi-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-03 15:13:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nisimi",
    "github_project": "learning-pypi-demo-nisimi",
    "github_not_found": true,
    "lcname": "learning-pypi-demo-nisimi"
}
nisimi
Elapsed time: 0.49699s