Skip to content

Commit

Permalink
package rename barbican -> outpost-barbican (#1)
Browse files Browse the repository at this point in the history
package rename `barbican` --> `outpost-barbican`

```console
pip install outpost-barbican
```

If used as lib, outpost is a namespace, e.g.
```python
from outpost import barbican
[...]
```
  • Loading branch information
fvalette-ledger authored Sep 17, 2024
2 parents 7765149 + b867701 commit 639c5ef
Show file tree
Hide file tree
Showing 49 changed files with 44 additions and 43 deletions.
6 changes: 3 additions & 3 deletions REUSE.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
# SPDX-License-Identifier: Apache-2.0

version = 1
SPDX-PackageName = "barbican"
SPDX-PackageSupplier = "Ledger SAS <firmware@ledger.fr>"
SPDX-PackageDownloadLocation = "https://github.com/outpost-os/python-barbican"
SPDX-PackageName = "outpost-barbican"
SPDX-PackageSupplier = "Ledger SAS <outpost-os@ledger.fr>"
SPDX-PackageDownloadLocation = "https://github.com/outpost-os/barbican"

[[annotations]]
path = "doc/**"
Expand Down
2 changes: 1 addition & 1 deletion doc/commands/barbican.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ Command line tool
==========================

.. argparse::
:module: barbican.barbican
:module: outpost.barbican.barbican
:func: main_argument_parser
:prog: barbican
4 changes: 2 additions & 2 deletions doc/commands/internals/capture_out.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
=============

.. argparse::
:module: barbican._internals.capture_out
:module: outpost.barbican._internals.capture_out
:func: argument_parser
:prog: barbican --internal capture_out

.. seealso::

:py:mod:`barbican._internals.capture_out` module documentation
:py:mod:`outpost.barbican._internals.capture_out` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/gen_ldscript.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
==============

.. argparse::
:module: barbican._internals.gen_ldscript
:module: outpost.barbican._internals.gen_ldscript
:func: argument_parser
:prog: barbican --internal gen_ldscript

.. seealso::

:py:mod:`barbican._internals.gen_ldscript` module documentation
:py:mod:`outpost.barbican._internals.gen_ldscript` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/gen_memory_layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
===================

.. argparse::
:module: barbican._internals.gen_memory_layout
:module: outpost.barbican._internals.gen_memory_layout
:func: argument_parser
:prog: barbican --internal gen_memory_layout

.. seealso::

:py:mod:`barbican._internals.gen_memory_layout` module documentation
:py:mod:`outpost.barbican._internals.gen_memory_layout` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/gen_task_metadata_bin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
=======================

.. argparse::
:module: barbican._internals.gen_task_metadata_bin
:module: outpost.barbican._internals.gen_task_metadata_bin
:func: argument_parser
:prog: barbican --internal gen_task_metadata_bin

.. seealso::

:py:mod:`barbican._internals.gen_task_metadata_bin` module documentation
:py:mod:`outpost.barbican._internals.gen_task_metadata_bin` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/kernel_fixup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
==============

.. argparse::
:module: barbican._internals.kernel_fixup
:module: outpost.barbican._internals.kernel_fixup
:func: argument_parser
:prog: barbican --internal kernel_fixup

.. seealso::

:py:mod:`barbican._internals.kernel_fixup` module documentation
:py:mod:`outpost.barbican._internals.kernel_fixup` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/meson_package_dyndep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
======================

.. argparse::
:module: barbican._internals.meson_package_dyndep
:module: outpost.barbican._internals.meson_package_dyndep
:func: argument_parser
:prog: barbican --internal meson_package_dyndep

.. seealso::

:py:mod:`barbican._internals.meson_package_dyndep` module documentation
:py:mod:`outpost.barbican._internals.meson_package_dyndep` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/objcopy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
=========

.. argparse::
:module: barbican._internals.objcopy
:module: outpost.barbican._internals.objcopy
:func: argument_parser
:prog: barbican --internal objcopy

.. seealso::

:py:mod:`barbican._internals.objcopy` module documentation
:py:mod:`outpost.barbican._internals.objcopy` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/relink_elf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
============

.. argparse::
:module: barbican._internals.relink_elf
:module: outpost.barbican._internals.relink_elf
:func: argument_parser
:prog: barbican --internal relink_elf

.. seealso::

:py:mod:`barbican._internals.relink_elf` module documentation
:py:mod:`outpost.barbican._internals.relink_elf` module documentation
4 changes: 2 additions & 2 deletions doc/commands/internals/srec_cat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
==========

.. argparse::
:module: barbican._internals.srec_cat
:module: outpost.barbican._internals.srec_cat
:func: argument_parser
:prog: barbican --internal srec_cat

.. seealso::

:py:mod:`barbican._internals.srec_cat` module documentation
:py:mod:`outpost.barbican._internals.srec_cat` module documentation
5 changes: 3 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from importlib import metadata

# General information about the project.
project = "barbican"
project = "outpost.barbican"
copyright = "2024, Ledger SAS"
author = "Ledger"

Expand Down Expand Up @@ -34,8 +34,9 @@
napoleon_attr_annotations = True

# Autoapi configuration
autoapi_dirs = ["../src"]
autoapi_dirs = ["../src/outpost"]
autoapi_add_toctree_entry = False
autoapi_python_use_implicit_namespaces = True

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
Expand Down
10 changes: 5 additions & 5 deletions doc/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ virtualenv).

.. code-block:: console
pip install [--user] barbican
pip install [--user] outpost-barbican
.. note::
Do not install for user in a virtualenv.
Expand Down Expand Up @@ -73,7 +73,7 @@ python linting, type checking, unit testing.

.. code-block:: console
pip install [--user] barbican[devel]
pip install [--user] outpost-barbican[devel]
doc
"""
Expand All @@ -90,7 +90,7 @@ is `numpydoc <https://numpydoc.readthedocs.io/en/latest/index.html>`_

.. code-block:: console
pip install [--user] barbican[doc]
pip install [--user] outpost-barbican[doc]
tools
"""""
Expand All @@ -107,15 +107,15 @@ a firmware.

.. code-block:: console
pip install [--user] barbican[tools]
pip install [--user] outpost-barbican[tools]
.. tip::

One can install all extra dependencies at once

.. code-block:: console
pip install [--user] barbican[devel,doc,tools]
pip install [--user] outpost-barbican[devel,doc,tools]
Development
-----------
Expand Down
2 changes: 1 addition & 1 deletion doc/python_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Barbican Python API
:maxdepth: 2
:caption: Contents:

autoapi/barbican/index
autoapi/outpost/barbican/index
14 changes: 7 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ requires = ["setuptools>=64", "setuptools_scm>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "barbican"
name = "outpost-barbican"
description = "Outpost-OS build system"
dynamic = ["version"]
requires-python = ">= 3.10"
readme = "README.md"
authors = [
{email = "Ledger SAS <firmware@ledger.fr>"},
{email = "Ledger SAS <outpost-os@ledger.fr>"},
]
license = {file = "LICENSES/Apache-2.0.txt"}
dependencies = [
Expand Down Expand Up @@ -49,13 +49,13 @@ classifiers = [
]

[project.urls]
Homepage = "https://git.orange.ledgerlabs.net/outpost"
Documentation = "https://pages.git.orange.ledgerlabs.net/outpost/outpostpedia/"
Repository = "https://git.orange.ledgerlabs.net/outpost/python-outpost.git"
Issues = "https://git.orange.ledgerlabs.net/outpost/python-outpost/issues"
Homepage = "https://github.com/outpost-os"
# Documentation = TODO
Repository = "https://github.com/outpost-os/barbican"
Issues = "https://github.com/outpost-os/barbican/issues"

[project.scripts]
barbican = "barbican.barbican:main"
barbican = "outpost.barbican.barbican:main"

[project.optional-dependencies]
devel = [
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

from importlib import metadata

__version__ = metadata.version("barbican")
__version__ = metadata.version("outpost.barbican")
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion tests/test_git.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from git import Repo
from git.exc import GitCommandError

from barbican.scm import Git
from outpost.barbican.scm import Git


class GitTestBase:
Expand Down
2 changes: 1 addition & 1 deletion tests/test_memory_layout.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import pytest
import typing

import barbican.utils.memory_layout as memory
import outpost.barbican.utils.memory_layout as memory


class TestMemoryRegion:
Expand Down
2 changes: 1 addition & 1 deletion tests/test_pow2_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# SPDX-License-Identifier: Apache-2.0

from barbican.utils import pow2_greatest_divisor, pow2_round_up, align_to
from outpost.barbican.utils import pow2_greatest_divisor, pow2_round_up, align_to


def test_align_to():
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ extras = devel

[testenv:unittests]
commands =
pytest --basetemp=.pytest_tmp --cov=barbican --tb=long -vv {posargs}
pytest --basetemp=.pytest_tmp --cov=outpost.barbican --tb=long -vv {posargs}
coverage report -m
coverage xml

[testenv:lint]
commands =
black --line-length 100 --check --diff .
mypy -p barbican
mypy -p outpost.barbican
flake8 --docstring-convention=numpy

[testenv:docs]
Expand Down

0 comments on commit 639c5ef

Please sign in to comment.