Documentation |

AnonymiGraph

Anonymization and Privacy Preserving Algorithms for Graphs in Python.

Table of Contents

• Codespaces: Development Without Installations
• Installation
  • From Git Repository
  • Local Installation
• Usage
• Contributing
• License

Codespaces: Development Without Installations

GitHub Codespaces simplifies development by providing a cloud-based environment accessible through your browser. No need to worry about any installation. To use it:

1. Navigate to the GitHub repository.
2. Click on the 'Code' button and select 'Open with Codespaces'.
3. Once the environment is set up, you're ready to go - no additional setup required!

Installation

From Git Repository

To install the package from the Git repository (not available on PyPI), run the following command:

pip install git+https://github.com/username/repository.git

Local Installation

For local development, you can install the project by following these steps:

1. Clone the repository:

   git clone https://github.com/username/repository.git

2. Navigate to the project directory:

   cd repository

3. Install the package:

   pip install -e .[full,test,dev]

4. Set up pre-commits:

   pre-commit install

5. Run pytest to check if your setup worked

   pytest .

Usage

Provide instructions on how to use the project after installation.

License

Include information about the project's license here.