semvec/pypi-packages huggingface dataset:
gumnut-simulator 1.1.0
Gumnut Simulator written in Python
Requires Python: >=3.6

.. image:: https://github.com/bwiessneth/gumnut-simulator/workflows/pytest/badge.svg
   :target: https://github.com/bwiessneth/gumnut-simulator/actions?query=workflow%3Apytest
   :alt: tests status

.. image:: https://readthedocs.org/projects/gumnut-simulator/badge/?version=latest
   :target: https://gumnut-simulator.readthedocs.io/en/latest/?badge=latest
   :alt: docs status



Gumnut Simulator
################

This projects contains several components which all revolve around Peter Ashenden's 8-bit soft-core
called *Gumnut*. For more information refer to *The Designers Guide to VHDL*
https://www.sciencedirect.com/book/9780120887859/the-designers-guide-to-vhdl

This repository was forked from my very first implementation created at the laboratory for digital
engineering at the University of Applied Sciences Augsburg back in 2015.



Documentation
*************

Please refer to https://gumnut-simulator.readthedocs.org



Changelog
*********


1.0.0
=====

Changed
-------

-  Enforced proper module names and naming convention



0.0.1
=====

Added
-----

-  Documentation (still in progress, though)
-  Introduced ``tox`` for handling testing, build, and publishing tasks
-  Introduced Github Actions for automated testing

Changed
-------

-  Replaced ``nosetest`` with ``pytest`` as the choice for unit and
   integration testing
-  Updated the existing tests for ``pytest``

Fixed
-----

-  Module imports were fixed
-  Enforced flake8 and (to some extend) pylint linting
dep-appearances 0.0.2
A simple tool to see where your dependencies are imported
Requires Python: >=3.6

# dep-appearances

A simple tool to see where your dependencies are imported.  The `dep-appearances`
CLI produces a report of which files import each of your dependencies.  At this
time, the CLI only works for projects that use
[`pipenv`](https://pipenv.pypa.io/en/latest/), but support for any dependency
management tool could be added.

## Requirements

* Python 3

## How to Use dep-appearances

You can install `dep-appearances` via `pip`:

```
pip install dep-appearances
```

Installing the package provides a CLI:

```
dep-appearances --help
usage: dep-appearances [-h] [--underused_threshold UNDERUSED_THRESHOLD] [PATH]

Find dependencies that are unused and underused in your codebase.

positional arguments:
  PATH                  The path to your project's root (defaults to your
                        current working directory)

optional arguments:
  -h, --help            show this help message and exit
  --underused_threshold UNDERUSED_THRESHOLD
                        The threshold to set for marking dependencies as
                        underused (default: 2)
```

From the root of your project (i.e. wherever your `Pipfile` is) you can run
`dep-appearances` and you will get a report of dependencies that don't appear to
imported _and_ a report of dependencies that my not be imported in very many
places.

```
> dep-appearances
Unused dependencies:
	build
	pytest
	twine

Underused dependencies (usage threshold = 2):
	pipfile
		imported in:
		src/dep_appearances/appearances_report.py:3
```

### Known Shortcomings

There are, unfortunately, packages that have a different name when importing
them than when installing them.  For example, the `apache-airflow` package shows
up in a Pipfile as `apache-airflow`, but when it is used in a codebase you use

```
import airflow
```

`dep-appearances` currently does **not** account for such cases.  Therefore
you should not remove dependencies from your codebase without confirming that
packages are unused.

## How to contribute to dep-appearances

Pull requests are definitely welcome.  Just fork this repo and open a PR
against the `main` branch.

### Useful Development Commands

Install dependencies

```
pipenv install
```

Install and use the package locally (to work on the CLI):

```
pipenv run pip install -e .
pipenv run dep-appearances
```

Running tests:

```
pipenv run pytest
```

## Release Process

```
# Generate distribution archives:
python3 -m build
# => Should create files in dist/

# Push to pypi
python3 -m twine upload dist/*
```

### Building for test.pypi


```
python3 -m build
python3 -m twine upload --repository testpypi dist/*
```

Install from test.pypi:

```
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps dep-appearances
```
unilakedocstheme 1.1.4
Unilake Docs Theme
Requires Python: >=3.6

# Introduction 
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. 

# Getting Started
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
1.	Installation process
2.	Software dependencies
3.	Latest releases
4.	API references

# Build and Test
TODO: Describe and show how to build your code and run the tests. 

# Contribute
TODO: Explain how other users and developers can contribute to make your code better. 

If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
- [ASP.NET Core](https://github.com/aspnet/Home)
- [Visual Studio Code](https://github.com/Microsoft/vscode)
- [Chakra Core](https://github.com/Microsoft/ChakraCore)
unilakedocs-theme 1.0.1
Unilake Docs Theme
Requires Python: >=3.6

# Introduction 
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. 

# Getting Started
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
1.	Installation process
2.	Software dependencies
3.	Latest releases
4.	API references

# Build and Test
TODO: Describe and show how to build your code and run the tests. 

# Contribute
TODO: Explain how other users and developers can contribute to make your code better. 

If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
- [ASP.NET Core](https://github.com/aspnet/Home)
- [Visual Studio Code](https://github.com/Microsoft/vscode)
- [Chakra Core](https://github.com/Microsoft/ChakraCore)