Skip to content

Commit 5525e7c

Browse files
Update doc
1 parent f1f43ed commit 5525e7c

3 files changed

Lines changed: 7 additions & 38 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -57,24 +57,6 @@ Follow the [NetworkX documentation guidelines](https://networkx.org/documentatio
5757

5858

5959

60-
## Dependency Management
61-
62-
This project uses [pip-tools](https://pip-tools.readthedocs.io/) to pin dependencies for reproducible builds. Top-level dependencies are declared in `pyproject.toml`, and exact versions are locked in:
63-
64-
| Lock file | Contents |
65-
|---|---|
66-
| `requirements.txt` | Core dependencies |
67-
| `requirements-dev.txt` | Test + developer dependencies |
68-
| `requirements-jupyter.txt` | Jupyter notebook dependencies |
69-
70-
When adding or changing a dependency:
71-
72-
1. Edit `pyproject.toml` with the new dependency or version range.
73-
2. Run `make lock` to regenerate the lock files.
74-
3. Run `make install-dev` to update your local environment.
75-
4. Commit both `pyproject.toml` and the updated lock files.
76-
77-
7860
## Code of Conduct
7961
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
8062
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact

Makefile

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,13 @@ show: ## Show the current environment.
2323
install: ## Install the project for examples.
2424
@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
2525
@echo "Don't forget to run 'make virtualenv' if you got errors."
26-
$(ENV_PREFIX)pip install -r requirements-jupyter.txt
27-
$(ENV_PREFIX)pip install -e . --no-deps
26+
$(ENV_PREFIX)pip install -e .[jupyter]
2827

2928
.PHONY: install-dev
30-
install-dev: ## Install the project in dev mode.
29+
install-dev: install ## Install the project in dev mode.
3130
@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
3231
@echo "Don't forget to run 'make virtualenv' if you got errors."
33-
$(ENV_PREFIX)pip install -r requirements-dev.txt
34-
$(ENV_PREFIX)pip install -e . --no-deps
32+
$(ENV_PREFIX)pip install -e .[test,developer]
3533

3634

3735
.PHONY: lock

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,16 @@ python -m pip wheel -w dist .
3333
pip install "dist/nx_neptune-0.5.0-py3-none-any.whl"
3434
```
3535

36-
### Install from source
36+
### Installation
37+
38+
To install the required nx_neptune dependencies:
3739

3840
```bash
3941
git clone git@github.com:awslabs/nx-neptune.git
4042
cd nx-neptune
4143

42-
# Create and activate a virtual environment
43-
make virtualenv
44-
source .venv/bin/activate
45-
46-
# Install from source (uses pinned lock files for reproducible builds)
44+
# install from source directly
4745
make install
48-
49-
# For development (includes test and linting tools)
50-
make install-dev
51-
```
52-
53-
Dependencies are pinned in lock files (`requirements.txt`, `requirements-dev.txt`, `requirements-jupyter.txt`) generated by [pip-tools](https://pip-tools.readthedocs.io/). If you update `pyproject.toml`, regenerate them with:
54-
55-
```bash
56-
make lock
5746
```
5847

5948
## Prerequisite

0 commit comments

Comments
 (0)