Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename project to ansible-dev-tools #32

Merged
merged 1 commit into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ cython_debug/
# and should all have detailed explanations

# Version created and populated by setuptools_scm
/src/ansible_cdk/_version.py
/src/ansible_dev_tools/_version.py

.DS_Store
_readthedocs
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The ansible content development kit

The `ansible-cdk` python package provides an easy way to install and discover the best tools available to create and test ansible content.
The `ansible-dev-tools` python package provides an easy way to install and discover the best tools available to create and test ansible content.

The curated list of tools installed as part of the ansible content development kit includes:

Expand All @@ -22,16 +22,16 @@ The curated list of tools installed as part of the ansible content development k

## Installation

`python -m pip install ansible-cdk`
`python -m pip install ansible-dev-tools`

## Usage

In addition to installing each of the above tools, `ansible-cdk` provides an easy way to show the versions of the content creation tools that make up the current development environment.
In addition to installing each of the above tools, `ansible-dev-tools` provides an easy way to show the versions of the content creation tools that make up the current development environment.

```
$ ansible-cdk --version
$ adt --version
ansible-builder 3.0.0
ansible-cdk 1.0.0
ansible-dev-tools 1.0.0
ansible-core 2.15.2
ansible-lint 6.17.2
ansible-navigator 3.4.2
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Ansible Content Development Kit (CDK)
# Ansible Development Tools (adt)

## About Ansible CDK
## About Ansible Development Tools

The `ansible-cdk` python package provides an easy way to install and discover the best tools available to create and test ansible content.
The `ansible-dev-tools` python package provides an easy way to install and discover the best tools available to create and test ansible content.

The curated list of tools installed as part of the ansible content development kit includes:

Expand Down
12 changes: 6 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
site_name: Ansible CDK Documentation
site_url: https://ansible.readthedocs.io/projects/ansible-cdk/
repo_url: https://github.com/ansible/ansible-cdk
site_url: https://ansible.readthedocs.io/projects/dev-tools/
repo_url: https://github.com/ansible/ansible-dev-tools
edit_uri: blob/main/docs/
copyright: Copyright © 2023 Red Hat, Inc.
docs_dir: docs
Expand All @@ -22,10 +22,10 @@ theme:
extra:
social:
- icon: fontawesome/brands/python
link: https://pypi.org/project/ansible-cdk/
link: https://pypi.org/project/ansible-dev-tools/
name: PyPI
- icon: fontawesome/solid/scroll
link: https://github.com/ansible/ansible-cdk/releases
link: https://github.com/ansible/ansible-dev-tools/releases
name: Releases
- icon: simple/mastodon
link: https://fosstodon.org/@ansible
Expand All @@ -34,10 +34,10 @@ extra:
link: https://matrix.to/#/#devtools:ansible.com
name: Matrix
- icon: fontawesome/solid/comments
link: https://github.com/ansible/ansible-cdk/discussions
link: https://github.com/ansible/ansible-dev-tools/discussions
name: Discussions
- icon: fontawesome/brands/github-alt
link: https://github.com/ansible/ansible-cdk
link: https://github.com/ansible/ansible-dev-tools
name: GitHub

nav:
Expand Down
16 changes: 8 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@ classifiers = [
'Topic :: Software Development',
'Topic :: Utilities'
]
description = "The ansible content development kit."
description = "Ansible Developtment Tools kit bundles all tools needed for content creation and testing."
dynamic = ["dependencies", "optional-dependencies", "version"]
keywords = ["ansible"]
license = {text = "GPL-3.0-only"}
maintainers = [{"email" = "info@ansible.com", "name" = "Ansible by Red Hat"}]
name = "ansible-cdk"
name = "ansible-dev-tools"
readme = "README.md"
requires-python = ">=3.9"

[project.scripts]
ansible-cdk = "ansible_cdk.cli:main"
adt = "ansible_dev_tools.cli:main"

[project.urls]
changelog = "https://github.com/ansible-community/ansible-cdk/releases"
documentation = "https://ansible-cdk.readthedocs.io/en/latest/"
homepage = "https://github.com/ansible-community/ansible-cdk"
repository = "https://github.com/ansible-community/ansible-cdk"
changelog = "https://github.com/ansible/ansible-dev-tools/releases"
documentation = "https://ansible-dev-tools.readthedocs.io/en/latest/"
homepage = "https://github.com/ansible/ansible-dev-tools"
repository = "https://github.com/ansible/ansible-dev-tools"

[tool.mypy]
files = ["src", "tests"]
Expand Down Expand Up @@ -265,7 +265,7 @@ optional-dependencies.test = {file = [".config/requirements-test.txt"]}

[tool.setuptools_scm]
local_scheme = "no-local-version"
write_to = "src/ansible_cdk/_version.py"
write_to = "src/ansible_dev_tools/_version.py"

[tool.tomlsort]
all = true
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""A runpy entry point for ansible-cdk.
"""A runpy entry point for ansible-dev-tools.

This makes it possible to invoke CLI
via :command:`python -m ansible_cdk`.
via :command:`python -m ansible_dev_tools`.
"""

from .cli import main
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

PKGS = [
"ansible-builder",
"ansible-cdk",
"ansible-dev-tools",
"ansible-core",
# "ansible-creator",
"ansible-lint",
Expand Down
4 changes: 2 additions & 2 deletions tests/integration/test_basic.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

import pytest

from ansible_cdk.version_builder import PKGS
from ansible_dev_tools.version_builder import PKGS


@pytest.mark.parametrize("package", PKGS)
def test_version(package: str) -> None:
"""Placeholder."""
command = f"{sys.executable} -m ansible_cdk --version"
command = f"{sys.executable} -m ansible_dev_tools --version"
proc = subprocess.run(
args=command,
shell=True,
Expand Down