Skip to content

Commit

Permalink
Create project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
shape-warrior-t committed Oct 30, 2023
1 parent ed46279 commit 14fa576
Show file tree
Hide file tree
Showing 9 changed files with 111 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: CI

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

permissions:
contents: read

jobs:
build:

runs-on: windows-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python 3.12
uses: actions/setup-python@v3
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8 flake8-pyproject pytest
- name: Lint with flake8
run: |
flake8
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Andy Guo, Lingyun Jiang, Bonan Luan, Alexander Mathioudakis, Liam Odero, Albert Yan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
58 changes: 58 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
[build-system]
requires = ["setuptools~=65.5.1", "wheel~=0.41.2"]
build-backend = "setuptools.build_meta"

[project]
name = "Astra"
version = ""
description = "Telemetry monitoring program developed for QEYnet."
readme = "README.md"
requires-python = "~=3.12"
license = "MIT"
keywords = []
authors = [
{name = "Andy Guo", email = "[email protected]"},
{name = "Lingyun Jiang", email = "[email protected]"},
{name = "Bonan Luan", email = "[email protected]"},
{name = "Alexander Mathioudakis", email = "[email protected]"},
{name = "Liam Odero", email = "[email protected]"},
{name = "Albert Yan", email = "[email protected]"}
]
maintainers = []
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: End Users/Desktop :: Science/Research",
"Environment :: Win32 (MS Windows)",
"Operating System :: Microsoft :: Windows",
"Natural Language :: English",
"Topic :: Scientific/Engineering",
"Programming Language :: Python :: 3.12",
]
dependencies = [

]

[project.urls]
source = ""
tracker = ""
documentation = ""

[project.scripts] # If any.


[tool.setuptools]
include-package-data = true

[tool.setuptools.packages.find]
exclude = []

[tool.flake8]
ignore = [
"W503" # Line break occurred before a binary operator.
]
exclude = [
".git", ".idea", "build", "config", "data", "dist", "docs", "venv", "wheels",
"*.egg", "*.egg-info/"
]
max-line-length = 100
count = true
Empty file added src/astra/data/.gitkeep
Empty file.
Empty file added src/astra/frontend/.gitkeep
Empty file.
Empty file added src/astra/usecase/.gitkeep
Empty file.
Empty file added tests/data/.gitkeep
Empty file.
Empty file added tests/frontend/.gitkeep
Empty file.
Empty file added tests/usecase/.gitkeep
Empty file.

0 comments on commit 14fa576

Please sign in to comment.