dep-sync

0.1.0 · active · verified Thu Apr 16

dep-sync is a helper Python library designed to synchronize Python environments with their declared dependencies. Currently at version 0.1.0, it provides a foundational tool for ensuring consistency across development and deployment environments. Given its early version, a rapid release cadence for bug fixes and new features is likely.

Common errors

```
ModuleNotFoundError: No module named 'dep_sync'
```
cause The `dep-sync` package was not installed or installed in a different Python environment than the one being used.

fix Ensure the package is installed in the active Python environment: `pip install dep-sync`.
```
AttributeError: module 'dep_sync' has no attribute 'sync_dependencies'
```
cause The specific function `sync_dependencies` might not exist or the import path is incorrect, or the API has changed in a non-documented way.

fix Verify the correct import paths and function names by checking the latest `dep-sync` documentation on GitHub, or inspect the package's installed files (e.g., `pip show dep-sync`, then examine the `Location` and package contents).

Warnings

gotcha As a 0.1.0 release, the API is subject to change. Direct imports or programmatic usage might be unstable across minor versions. It's recommended to pin the version to avoid unexpected breaking changes.
Fix: Pin the library version in your `requirements.txt` or `pyproject.toml` (e.g., `dep-sync==0.1.0`). Regularly check the GitHub repository for updates and changelogs before upgrading.
gotcha The documentation for version 0.1.0 is minimal. Specific API details, advanced usage patterns, and configuration options might not be explicitly covered, requiring users to infer usage from source or experimentation.
Fix: Refer to the project's GitHub repository for the most up-to-date `README.md` and any inline code comments. Be prepared to explore the library's source code for detailed understanding.

Install

pip install dep-sync Install with pip

Imports

sync_dependencies
```
from dep_sync import sync_dependencies
```

Quickstart

The `dep-sync` library is primarily used to synchronize project dependencies, often by reading from `pyproject.toml` or `requirements.txt`. The core functionality is exposed via a function like `sync_dependencies`. In its initial release (0.1.0), the exact API details are best inferred from its intended purpose of environment synchronization.

from dep_sync import sync_dependencies

# Assuming pyproject.toml and requirements.txt are in the current directory
# This function will analyze your project and synchronize dependencies.
# The exact parameters and their usage would typically be detailed in comprehensive documentation.
# For a basic synchronization, often no arguments are needed if conventions are followed.
# For example, it might implicitly look for pyproject.toml or requirements.txt.
# Placeholder for typical command-line equivalent execution:
# You would typically run 'dep-sync' from your terminal in the project root.
# The Python API might expose a similar underlying function for programmatic use.

try:
    sync_dependencies()
    print("Dependencies synchronized successfully.")
except Exception as e:
    print(f"An error occurred during synchronization: {e}")

view raw JSON →