An open API service indexing awesome lists of open source software.

https://github.com/lfreleng-actions/python-project-name-action

Extracts Python project name and derives the package name
https://github.com/lfreleng-actions/python-project-name-action

name naming project projects python

Last synced: 5 months ago
JSON representation

Extracts Python project name and derives the package name

Awesome Lists containing this project

README

          

# 🐍 Python Project/Package Names

Extracts the Python project name and derives the Python package name.

## python-project-name-action

## Usage Example

An example workflow step using this action:

```yaml
steps:
# Code checkout performed in earlier step
- name: Fetch Python project/package name
uses: lfreleng-actions/python-project-name-action@main
```

##  Inputs

| Variable Name | Required | Description |
| ------------------- | -------- | ------------------------------------- |
| PATH_PREFIX | False | Path/directory to Python project code |

## Outputs

| Output Variable | Mandatory | Value |
| ------------------- | --------- | --------------------------------------------------------- |
| PYTHON_PACKAGE_FILE | Yes | File used to extract metadata: pyproject.toml or setup.py |
| PYTHON_PROJECT_NAME | Yes | Extracted from pyproject.toml/setup.py |
| PYTHON_PACKAGE_NAME | Yes | Derived from value in pyproject.toml/setup.py |