Skip to content

1iis/atlas

Repository files navigation

Atlas

Atlas is a system for mapping and understanding codebases. Its first target is repository-level orientation: producing compact, accurate, information-rich cards and views that help a human or LLM understand what a repo is, how it works, whether it is useful, and where to begin reading.

Important

Built for Python code first.
More languages to come; quality may depend on introspection features and/or the availability of language analysis tools.

The project is nowhere near stable enough to warrant contributions yet, but when that day comes, the power of crowds can shine in bridging Atlas with every language under the sun, and in refining hybrid codebases analysis.


Tip

uv lifecycle

Setup

# Clone repo
gh repo clone 1iis/py
cd atlas
  • To develop it, install deps (fastship, ruff, etc.) and create .venv/: uv sync reads .python-version (downloads it if missing), creates .venv/, resolves all deps, writes uv.lock.

    uv sync --group dev
  • To use it, install the tool globally.

    uv tool install --editable .

    Check that it works:

    cd $some_repo
    atlas
    # You may need to add uv's tool exec dir to your PATH
    uv tool update-shell

Run

uv run pytest            # run tests
uv run ruff check src/   # lint
uv run ruff format src/  # format
uv run atlas […]         # run CLI

uv run activates the virtual environment automatically for that command.

Adding dependencies

uv add requests              # runtime dep → pyproject.toml + uv.lock
uv add --group dev pytest    # dev dep → [dependency-groups] dev
uv sync                      # install everything

Shipping (with fastship)

ship-bump --part 2           # bump patch: 0.0.1 → 0.0.2
ship-pypi                    # build + upload to PyPI

These are already installed via uv sync --group dev. No activation needed.

When to uv sync

Run it after:

  • git pull (someone changed deps)
  • switching branches
  • manually editing pyproject.toml deps

About

Atlas is a system for mapping and understanding codebases. Its first target is repository-level orientation: producing compact, accurate, information-rich cards and views that help a human or LLM understand what a repo is, how it works, whether it is useful, and where to begin reading.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

Generated from 1iis/py