Skip to content

Commit

Permalink
rename to grid1q
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanCQC committed Dec 9, 2023
1 parent 6c91beb commit 998bf68
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FROM python:3.11-slim-buster

# Set the working directory to /pytemplate
WORKDIR /pytemplate
# Set the working directory to /grid1q
WORKDIR /grid1q

# Copy the pyproject.toml and requirements.txt files to the container
COPY . .
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ lint:
pre-commit run --all-files

docs:
sphinx-apidoc -f -o docs/source/ pytemplate
sphinx-apidoc -f -o docs/source/ grid1q
sphinx-build -M html docs/source/ docs/build/

clean:
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# pytemplate
# grid1q

This is a Python 3.11 app called pytemplate. The project includes Docker, Pyright, Ruff, GitHub Actions, Black, pre-commit, and Sphinx.
This is a Python 3.11 app called grid1q. The project includes Docker, Pyright, Ruff, GitHub Actions, Black, pre-commit, and Sphinx.

## Project Structure

The project structure is as follows:

```sh
pytemplate
grid1q
├── .dockerignore
├── .github
│   └── workflows
Expand All @@ -23,7 +23,7 @@ pytemplate
│   ├── conf.py
│   └── index.rst
├── pyproject.toml
├── pytemplate
├── grid1q
│   ├── __init__.py
│   ├── main.py
│   └── utils.py
Expand All @@ -34,7 +34,7 @@ pytemplate
└── test_utils.py
```

The source code is located in the `pytemplate` folder, which contains the `__init__.py`, `main.py`, and `utils.py` files. The tests are located in the `tests` folder, which contains the `test_main.py` and `test_utils.py` files.
The source code is located in the `grid1q` folder, which contains the `__init__.py`, `main.py`, and `utils.py` files. The tests are located in the `tests` folder, which contains the `test_main.py` and `test_utils.py` files.

The project uses toml for configuration instead of `setup.py`. The configuration file is located in `pyproject.toml`.

Expand All @@ -48,7 +48,7 @@ The project includes GitHub Actions for continuous integration, with the configu

## Usage Notes

[Replace](https://github.com/your-tools/ruplacer) all mentions of "pytemplate" to your own project's name.
[Replace](https://github.com/your-tools/ruplacer) all mentions of "grid1q" to your own project's name.

## Installation

Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "pytemplate"
project_copyright = "2023, Author"
author = "Author"
project = "grid1q"
project_copyright = "2023, Nathan Fitzpatrick"
author = "Nathan Fitzpatrick"
release = "0.0.1"

# -- General configuration ---------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions grid1q/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Init file for grid1q."""
2 changes: 1 addition & 1 deletion pytemplate/main.py → grid1q/main.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""This is the main module of the pytemplate package."""
"""This is the main module of the grid1q package."""


def hello_world() -> str:
Expand Down
2 changes: 1 addition & 1 deletion pytemplate/utils.py → grid1q/utils.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Utility functions for the pytemplate package."""
"""Utility functions for the grid1q package."""


def add_numbers(a: int, b: int) -> int:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "pytemplate"
name = "grid1q"
version = "0.0.1"
description = "A python library"
readme = "README.md"
requires-python = ">=3.11"
authors = [{name = "Author", email = "author@email.com" }]
authors = [{name = "Nathan Fitzpatrick", email = "nathan.fitzpatrick@quantinumm.com" }]

[tool.setuptools.packages.find]
where = ["."]
Expand All @@ -18,7 +18,7 @@ Repository = "https://github.com/CQCL/pytemplate.git"

# See https://microsoft.github.io/pyright/#/getting-started
[tool.pyright]
include = ["pytemplate","tests"]
include = ["grid1q","tests"]
ignore = ["**/*.ipynb"]
pythonVersion = "3.11"
typeCheckingMode = "strict"
Expand Down
1 change: 0 additions & 1 deletion pytemplate/__init__.py

This file was deleted.

4 changes: 2 additions & 2 deletions tests/test_main.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Tests for pytemplate.main module."""
"""Tests for grid1q.main module."""

from pytemplate.main import hello_world
from grid1q.main import hello_world


def test_hello_world():
Expand Down
4 changes: 2 additions & 2 deletions tests/test_utils.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Tests for pytemplate.utils."""
"""Tests for grid1q.utils."""

from pytemplate.utils import add_numbers
from grid1q.utils import add_numbers


def test_add():
Expand Down

0 comments on commit 998bf68

Please sign in to comment.