Skip to content

Commit

Permalink
test
Browse files Browse the repository at this point in the history
  • Loading branch information
Kylehtran committed Oct 26, 2024
1 parent 2a8ae1b commit ee0ab37
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 50 deletions.
46 changes: 1 addition & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1 @@
# python-repo-example
Example Python Package Repository. This repository serves as an example of how to set up a Python repository for UCSD Engineers for Exploration.

## .vscode
This folder should contain at least a `launch.json` file that provides entry points into the package. This could be entry points to example programs, typical debug entry points, etc. Ideally, this will also contain a `settings.json` with folder specific VS Code settings.

## Python Packages
Almost all code should be organized into packages. This facilitates easy code reuse. See https://packaging.python.org/en/latest/ for more information on how to use packages in Python.

## tests
Tests should ideally be kept in an isolated folder. This example uses `pytest`, see https://docs.pytest.org/en/7.0.x/ for information on how to use `pytest`.

## .gitignore
This is an important file to put into your `git` repositories. This helps prevent `git` from including unnecessary files into the version control system, such as generated files, environment files, or log files.

## Jupyter Notebooks
Jupyter Notebooks are a great way to add interactive reports or documentation. There is an example here.

## *.code-workspace
This is created by going to `File`->`Save Workspace As` in VS Code. This allows us to easily open the same development environment across computers and operating systems. Use this as the root of your development environment.

You'll also notice here that there are some recommended extensions. This allows everyone on your team to have a consistent toolchain for how to interact with your code. See https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions for instructions for how to configure these.

## README.md
This is a critical file to include. This should be an introduction to your repository. It should be a birds-eye view of what your repo is and how to use it, with links to the appropriate lower-level documentation.

## setup.py
This is the original way to package Python projects, which we probably still prefer. However, in general, if you can, you should probably start using the newer packaging tools (`pyproject.toml`)

See https://packaging.python.org/en/latest/tutorials/packaging-projects/ and https://docs.python.org/3/distutils/setupscript.html for more information about each tool.

## Installing for developers
Developers should do the following:
```
# Create a virtual environment
python -m venv .venv
# Activate the virtual environment
.venv/Scripts/activate.ps1 # for Windows PowerShell
.venv/Scripts/activate.bat # for Windows Command Prompt
source .venv/bin/activate # for bash
# Install in developer mode
python -m pip install -e .[dev]
```
git clone with --recurse-submodules
2 changes: 1 addition & 1 deletion fishsense-database
Submodule fishsense-database updated from 8bb558 to 754a5f
7 changes: 3 additions & 4 deletions fishsense_services/routes/usr/login.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@

from os import abort
from typing import Dict
from urllib import request

from fastapi import APIRouter
from fastapi import APIRouter, Request
from google.auth.transport import requests
from google.oauth2 import id_token

Expand All @@ -13,12 +12,12 @@
login_router = APIRouter()



# possible routes: reset passwrod, need to check if there is account associated with it

@login_router.post("/api/login")
def verify_token():
try:
token: Dict[str, str] = request.json
token: Dict[str, str] = Request.json
idinfo = id_token.verify_oauth2_token(
token["credential"], requests.Request(), CLIENT_ID
)
Expand Down

0 comments on commit ee0ab37

Please sign in to comment.