Metadata-Version: 2.3
Name: ipctools
Version: 0.0.0
Summary: Inter-process communication tools.
Author: Narvin Singh
Author-email: Narvin Singh <Narvin.A.Singh@gmail.com>
License: Inter-process communication tools.
         Copyright (C) 2026  Narvin Singh
         
         This program is free software: you can redistribute it and/or modify
         it under the terms of the GNU General Public License as published by
         the Free Software Foundation, either version 3 of the License, or
         (at your option) any later version.
         
         This program is distributed in the hope that it will be useful,
         but WITHOUT ANY WARRANTY; without even the implied warranty of
         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
         GNU General Public License for more details.
         
         You should have received a copy of the GNU General Public License
         along with this program.  If not, see <https://www.gnu.org/licenses/>.
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Dist: python-docs-theme~=2025.12 ; extra == 'doc'
Requires-Dist: sphinx~=9.1 ; extra == 'doc'
Requires-Python: >=3.12
Project-URL: Homepage, https://gitlab.com/narvin/ipctools
Project-URL: Repository, https://gitlab.com/narvin/ipctools
Project-URL: Bug Tracker, https://gitlab.com/narvin/ipctools/-/issues
Provides-Extra: doc
Description-Content-Type: text/x-rst

Ipctools
########

Inter-process communication tools.

This is a template project that can be used to publish a package to `PyPI
<https://pypi.org/>`__.

Installation
************

Create a ``.env`` file in the project directory with your `PyPI token
<https://pypi.org/help/#apitoken>`__ so you can publish packages.

.. code-block:: shell

   echo "PYPI_TOKEN=<your token>" > .env

``git`` and ``uv`` should be installed on your system. ``uv`` may be installed
by running ``make uv``.

Unless you use the ``unsafe`` option, then you must set ``GIT_PATH`` and
``UV_PATH`` to the location of these tools on your system. You may also set
these in the ``.env`` file.

Usage
*****

Apply data to the template.

.. code-block:: shell

   uv run -m src.pypireg apply -n "<project name>" -d "<project description>"

The project will be customized with the data, and files and directories will be
renamed. You may copy, and rename the project directory, then begin working on
the customized project. There are ``make`` recipes to install the project,
build documentation, perform code quality checks, run unit tests, and build and
publish the package to PyPI. The first thing you may want to do is attempt to
publish your new package in order to reserve the name if it is available.

Restore the project to its original state.

.. note::

   Since the package directory has been renamed, instead of ``src.pypireg``,
   you must reference the package by its new name.

.. code-block:: shell

   uv run -m src.<project name> restore

