Skip to content

hyoklee/iowarp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iowarp

Test Package Publish to PyPI PyPI version

A PyPI wrapper package that installs both iowarp-agent-toolkit and iowarp-core.

Installation

Install the package from PyPI:

pip install iowarp

This will automatically install both:

  • iowarp-agent-toolkit
  • iowarp-core

Usage

Simply import the package in your Python code:

import iowarp

print(f"IOWarp version: {iowarp.__version__}")

The underlying packages will be available for import as well:

import iowarp_agent_toolkit
import iowarp_core

Uninstallation

To completely remove all IOWarp components, you need to explicitly uninstall all packages since pip doesn't automatically remove dependencies:

pip uninstall iowarp iowarp-agent-toolkit iowarp-core

Alternatively, if you have pip-autoremove installed:

pip install pip-autoremove
pip-autoremove iowarp -y

Development

Building the package locally

pip install build
python -m build

Running tests

The test suite is automatically run via GitHub Actions on every push and pull request.

Publishing

The package is automatically published to PyPI when a new release is created or a tag starting with v is pushed.

To publish a new version:

  1. Update the version in pyproject.toml and src/iowarp/__init__.py
  2. Create a new release on GitHub with a tag like v0.1.0
  3. The GitHub Action will automatically build and publish to PyPI

Make sure the PYPI_TOKEN secret is configured in your GitHub repository settings.

License

BSD 3-Clause License - see LICENSE file for details.

About

PyPi Package for IOWarp Packages

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages