Metadata-Version: 2.1
Name: sullivan
Version: 0.1.1
Summary: Cargo for Python - a hassle-free package manager for Python
Home-page: https://github.com/viraatdas/sullivan
Author: Viraat Das
Author-email: viraat.laldas@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: toml

# sullivan 
Cargo for for Python - package manager for python

## Features
- [ ] **Initialize Projects**: Create a new Python project with a standard structure.
- [ ] **Install Packages**: Install Python packages and manage dependencies.
- [ ] **Configure Repository**: Set and configure package repositories.
- [ ] **Run Projects**: Run Python projects with a simple command.
- [ ] **Run Tests**: Run tests for your Python project.
- [ ] **Generate Documentation**: Generate documentation for your Python project.
- [ ] Super fast dependency management
- [ ] Better lock file management
- [ ] Easy to publish to pypi/other repositories
- [ ] Integrated testing and coverage
- [ ] Security features to identify old packages
- [ ] Easily allow you to configure Python versions (without explicitly using pyenv)

## Installation
*todo*

## Usage

### Initialize a project
```
sullivan init <project_name>
```

Ex.
```
sullivan init my_project
```

This will produce:
```
my_project/
├── sullivan.toml
├── setup.py
├── src/
│   └── main.py
├── tests/
│   └── test_main.py
├── target/
│   └── dependencies/
```

### Install a package
```
sullivan install <package_name>
```

### Configure repository 
```
sullivan configure <repository_url>
``` 

This can also be modified from the `sullivan.toml` file

### Run the project
```
sullivan run
```

### Run tests
```
sullivan test
```


### Generate documentation
```
sullivan doc
```


## Local dependency management
To mimic Cargo’s local installation approach:

- Dependencies will be installed in a target/dependencies directory within the project.
- Each project's environment will be isolated to ensure no conflicts with global Python packages.


## Notes 
- Ensure compatibility with existing tools and libraries within the Python ecosystem.
- Provide a clear and simple way to manage Python versions.
- Optimize performance for dependency resolution and installation.

