Skip to content

Commit

Permalink
Rename lvmtools -> lvmopstools
Browse files Browse the repository at this point in the history
  • Loading branch information
albireox committed Jan 2, 2024
1 parent c92f89c commit fc88cca
Show file tree
Hide file tree
Showing 11 changed files with 428 additions and 1,655 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
- name: Create release
uses: softprops/action-gh-release@v1
with:
name: lvmtools ${{ github.ref_name }}
name: lvmopstools ${{ github.ref_name }}

- name: Set up Python
uses: actions/setup-python@v4
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# lvmtools
# lvmopstools

![Versions](https://img.shields.io/badge/python->3.10-blue)
[![Documentation Status](https://readthedocs.org/projects/lvmtools/badge/?version=latest)](https://lvmtools.readthedocs.io/en/latest/)
[![Test](https://github.com/sdss/lvmtools/actions/workflows/test.yml/badge.svg)](https://github.com/sdss/lvmtools/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/sdss/lvmtools/branch/main/graph/badge.svg)](https://codecov.io/gh/sdss/lvmtools)
[![Documentation Status](https://readthedocs.org/projects/lvmopstools/badge/?version=latest)](https://lvmopstools.readthedocs.io/en/latest/)
[![Test](https://github.com/sdss/lvmopstools/actions/workflows/test.yml/badge.svg)](https://github.com/sdss/lvmopstools/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/sdss/lvmopstools/branch/main/graph/badge.svg)](https://codecov.io/gh/sdss/lvmopstools)

LVM tools and utilities
LVM tools and utilities for operations.

**Documentation:** https://lvmtools.readthedocs.io/en/latest/index.html
**Documentation:** https://lvmopstools.readthedocs.io/en/latest/index.html
2 changes: 1 addition & 1 deletion docs/sphinx/changelog.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(lvmtools-changelog)=
(lvmopstools-changelog)=

```{include} ../../CHANGELOG.md
```
11 changes: 6 additions & 5 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import os

from lvmtools import __version__
from pkg_resources import parse_version

from lvmopstools import __version__


# Are we building in RTD?
on_rtd = os.environ.get("READTHEDOCS") == "True"
Expand Down Expand Up @@ -45,7 +46,7 @@
master_doc = "index"

# General information about the project.
project = "lvmtools"
project = "lvmopstools"
copyright = "{0}, {1}".format("2023-", "José Sánchez-Gallego")
author = "José Sánchez-Gallego"

Expand Down Expand Up @@ -122,7 +123,7 @@
copybutton_prompt_is_regexp = True

rst_epilog = f"""
.. |lvmtools_version| replace:: {__version__}
.. |lvmopstools_version| replace:: {__version__}
.. default-role:: py:obj
"""

Expand All @@ -132,11 +133,11 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "furo"
html_title = "lvmtools's documentation"
html_title = "lvmopstools's documentation"
html_logo = "_static/lvm_logo.png"
html_favicon = "./_static/favicon.ico"
html_theme_options = {
"source_repository": "https://github.com/sdss/lvmtools/",
"source_repository": "https://github.com/sdss/lvmopstools/",
"source_branch": "main",
"source_directory": "docs/sphinx",
}
Expand Down
10 changes: 5 additions & 5 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@

lvmtools's documentation
lvmopstools's documentation
=======================

This is the documentation for the SDSS Python product ``lvmtools``. The current version is |lvmtools_version|. You can install the package by doing
This is the documentation for the SDSS Python product ``lvmopstools``. The current version is |lvmopstools_version|. You can install the package by doing

.. code:: console
$ pip install lvmtools
$ pip install lvmopstools
Contents
Expand All @@ -19,8 +19,8 @@ Contents
Links
-----

* `Repository <https://github.com/sdss/lvmtools>`__
* `Issue tracking <https://github.com/sdss/lvmtools/issues>`__
* `Repository <https://github.com/sdss/lvmopstools>`__
* `Issue tracking <https://github.com/sdss/lvmopstools/issues>`__


Indices and tables
Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def docs_live(session):
# for sphinx
"-b=dirhtml",
"-a",
"--watch=../../src/lvmtools",
"--watch=../../src/lvmopstools",
docs_dir,
destination,
external=True,
Expand Down
1,973 changes: 392 additions & 1,581 deletions poetry.lock

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[tool.poetry]
name = "lvmtools"
name = "lvmopstools"
version = "0.1.0a0"
description = "LVM tools and utilities"
description = "LVM tools and utilities for operations"
authors = ["José Sánchez-Gallego <[email protected]>"]
license = "BSD-3-Clause"
readme = "README.md"
homepage = "https://github.com/sdss/lvmtools"
repository = "https://github.com/sdss/lvmtools"
documentation = "https://lvmtools.readthedocs.org"
homepage = "https://github.com/sdss/lvmopstools"
repository = "https://github.com/sdss/lvmopstools"
documentation = "https://lvmopstools.readthedocs.org"
keywords = ["astronomy", "software"]
classifiers = [
"Intended Audience :: Science/Research",
Expand All @@ -20,9 +20,9 @@ classifiers = [
"Topic :: Software Development :: Libraries :: Python Modules"
]
packages = [
{ include = "lvmtools", from = "src" }
{ include = "lvmopstools", from = "src" }
]
include = ["src/lvmtools/*.yaml"]
include = ["src/lvmopstools/*.yaml"]


[tool.poetry.dependencies]
Expand Down Expand Up @@ -66,7 +66,7 @@ unfixable = ["F841"]
"__init__.py" = ["F403", "E402", "F401"]

[tool.ruff.isort]
known-first-party = ["lvmtools"]
known-first-party = ["lvmopstools"]
lines-after-imports = 2
section-order = ["future", "standard-library", "typing", "third-party", "sdss", "first-party", "local-folder"]

Expand All @@ -75,16 +75,16 @@ typing = ["typing"]
sdss = ["sdsstools"]

[tool.pytest.ini_options]
addopts = "--cov lvmtools --cov-report xml --cov-report html --cov-report term -W ignore"
addopts = "--cov lvmopstools --cov-report xml --cov-report html --cov-report term -W ignore"
asyncio_mode = "auto"

[tool.coverage.run]
branch = true
include = ["src/lvmtools/*"]
include = ["src/lvmopstools/*"]
omit = [
"*/__init__.py",
"src/lvmtools/__main__.py",
"src/lvmtools/types.py",
"src/lvmopstools/__main__.py",
"src/lvmopstools/types.py",
]

[tool.coverage.report]
Expand Down
File renamed without changes.
39 changes: 0 additions & 39 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,3 @@
# @License: BSD 3-clause (http://www.opensource.org/licenses/BSD-3-Clause)

from __future__ import annotations

import pytest

from clu.command import Command, CommandStatus

import lvmtools.tools


@pytest.fixture()
def command_done():
command = Command()
command.status = CommandStatus.DONE

yield command


@pytest.fixture()
def command_failed():
command = Command()
command.status = CommandStatus.FAILED

yield command


@pytest.fixture()
async def mock_client_start(mocker):
yield mocker.patch.object(
lvmtools.tools.AMQPClient,
"start",
)


@pytest.fixture()
async def mock_client_send_command(mock_client_start, mocker, command_done):
yield mocker.patch.object(
lvmtools.tools.AMQPClient,
"send_command",
return_value=command_done,
)
8 changes: 4 additions & 4 deletions tests/test_lvmtools.py → tests/test_lvmopstools.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
#
# @Author: José Sánchez-Gallego ([email protected])
# @Date: 2024-01-02
# @Filename: test_lvmtools.py
# @Filename: test_lvmopstools.py
# @License: BSD 3-clause (http://www.opensource.org/licenses/BSD-3-Clause)

from __future__ import annotations


async def test_lvmtools_import():
import lvmtools
async def test_lvmopstools_import():
import lvmopstools

assert lvmtools is not None
assert lvmopstools is not None

0 comments on commit fc88cca

Please sign in to comment.