Skip to content

Commit

Permalink
Preparing for 2.7 by Updating README links (#2)
Browse files Browse the repository at this point in the history
* Fixing Sphinx-related links that do not work with PyPI

* Updating the version number for the initial release.

* Fixing a broken link

* Adding the version badge

* Fixing a few duplicate links.

* Updating the links with our new URLs

* Adding in dependabot to help with dependency management.
  • Loading branch information
sdelliot authored Nov 15, 2024
1 parent ec3a83e commit 02627dd
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 10 deletions.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
18 changes: 10 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ FIREWHEEL
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: CODE_OF_CONDUCT.md

.. image:: https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%7C%203.11%7C%203.12%7C%203.13-blue

.. readme-inclusion-marker
FIREWHEEL is an experiment orchestration tool that assists a user in building and controlling, repeatable experiments of distributed network systems at any scale.
Expand All @@ -21,11 +23,11 @@ Therefore, it is trivial to run hundreds of experiments and collect results on t
Getting Started
***************

* For a crash course on key FIREWHEEL concepts and on using FIREWHEEL please see our :ref:`quickstart-guide` guide.
* To learn why experimentation may be the right tool to answer certain kinds of questions (and when it is probably the wrong tool) see :ref:`emulytics-introduction`.
* An overview of FIREWHEEL including how FIREWHEEL can help a researcher implement high-quality emulation-based experiments, hardware requirements, software architecture, and known security security concerns is provided in :ref:`FIREWHEEL-introduction`.
* An in-depth review of important FIREWHEEL concepts, is located in :ref:`FIREWHEEL-concepts`.
* The CLI reference documentation can be found in :ref:`cli`.
* For a crash course on key FIREWHEEL concepts and on using FIREWHEEL please see our `quickstart-guide <https://sandialabs.github.io/firewheel/quickstart.html>`_ guide.
* To learn why experimentation may be the right tool to answer certain kinds of questions (and when it is probably the wrong tool) review our documentation on `Cyber Experimentation <https://sandialabs.github.io/firewheel/emulytics.html>`_.
* An overview of FIREWHEEL including how FIREWHEEL can help a researcher implement high-quality emulation-based experiments, hardware requirements, software architecture, and known security security concerns is provided in our `System Overview <https://sandialabs.github.io/firewheel/system/index.html>`_.
* An in-depth review of important FIREWHEEL concepts, is located `here <https://sandialabs.github.io/firewheel/concepts.html>`__.
* The CLI reference documentation can be found `here <https://sandialabs.github.io/firewheel/cli/index.html>`__.


****************************
Expand All @@ -36,17 +38,17 @@ If you have questions you'd like to ask the developers which our documentation d

Please report any bugs that you find on our GitHub page.
We happily accept pull requests (PR), big or small.
Please see the :ref:`contributing` for more information.
Please see the `Contributor Guide <https://sandialabs.github.io/firewheel/developer/contributing.html>`_ for more information.

Any security-related issues should be reported directly to the developers at: ``firewheel AT sandia DOT gov`` (see :ref:`SECURITY <security>`) for more information.
Any security-related issues should be reported directly to the developers at: ``firewheel AT sandia DOT gov`` (see `SECURITY.md <https://sandialabs.github.io/firewheel/developer/security.html>`_) for more information.

*******
License
*******
Copyright 2024 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.

Please see :ref:`LICENSE <license>` for more information.
Please see `LICENSE <https://sandialabs.github.io/firewheel/developer/license.html>`_ for more information.

************************
Research Using FIREWHEEL
Expand Down
6 changes: 5 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,11 @@ dev = [
]

[project.urls] # Optional
"Homepage" = "https://www.sandia.gov/emulytics"
homepage = "https://www.sandia.gov/emulytics"
documentation = "https://sandialabs.github.io/firewheel/"
repository = "https://github.com/sandialabs/firewheel/"
issue_tracker = "https://github.com/sandialabs/firewheel/issues"
changelog = "https://sandialabs.github.io/firewheel/developer/changelog.html"

[project.scripts]
firewheel = "firewheel.cli.firewheel_cli:main"
Expand Down
2 changes: 1 addition & 1 deletion src/firewheel/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from pathlib import Path

__version__ = "2.6.0"
__version__ = "2.7.0"

FIREWHEEL_PACKAGE_DIR = Path(__file__).parent

0 comments on commit 02627dd

Please sign in to comment.