Skip to main content

List of files that indicate a project root

Project description

> project-markers

Common project root markers.

It's just a JSON file, so you can use it in any environment.

Installation

pip install project-markers

Usage

import project_markers

print(project_markers)
# => ['.ansible-lint', '.bazelrc', '.browserslistrc', '.buckconfig', ...]

Note: Most type checkers will falsely warn project_markers is not iterable because they are incapable of analyzing runtime behavior (where the module is replaced w/ a list for cleaner, direct access). You can safely suppress such warnings using # type: ignore.

The list includes hundreds of markers from many tools and ecosystems, including:

  • Version control (.git, .hg, .svn)
  • Python (pyproject.toml, setup.py, requirements.txt)
  • JavaScript (package.json, yarn.lock, tsconfig.json)
  • Docker/K8s (Dockerfile, docker-compose.yml)
  • CI/CD (.github, .gitlab-ci.yml, Jenkinsfile)

MIT License

Copyright © 2026 Adam Lui

Related

📂 find-project-root - Locate project root via custom markers.
📊 get-min-py - Get the minimum Python version required for a PyPI package.

More Python utilities

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

project_markers-1.0.3.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

project_markers-1.0.3-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file project_markers-1.0.3.tar.gz.

File metadata

  • Download URL: project_markers-1.0.3.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for project_markers-1.0.3.tar.gz
Algorithm Hash digest
SHA256 e2718b038c89d1c02f86aa224df7eafeb998ed0f6245289881ce24152d566bd1
MD5 d2bb707ebeda8530a014078e9c8077e0
BLAKE2b-256 eaa5a13fd1ae19c71a315d72e37897234eb60cc263ef23e52945fa33e04a6d72

See more details on using hashes here.

File details

Details for the file project_markers-1.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for project_markers-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 95764962a672d4857a853790d7d8cec167adfd46a2520f154fbeaf11dd79da08
MD5 015351e01a69ef36b92c6f739e604426
BLAKE2b-256 76dff1d51dbb43a6c5e2eda75ae8d7eb7db3febdc36e90b7f2ca14219bc2e706

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page