Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kunzite - Abby & Aisha #24

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,34 @@
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
from dotenv import load_dotenv
import os

db = SQLAlchemy()
migrate = Migrate()
load_dotenv()

def create_app(test_config=None):
app = Flask(__name__)

# app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good practice to remove extraneous commented out code.

# app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development'

if not test_config:
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get(
"SQLALCHEMY_DATABASE_URI")
else:
app.config["TESTING"] = True
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this line of code is in both the else and the if blocks, it could be moved outside this control flow structure so we don't repeat it.

app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get(
"SQLALCHEMY_TEST_DATABASE_URI")

db.init_app(app)
migrate.init_app(app, db)
from app.models.planet import Planet

from .routes.routes import bp
app.register_blueprint(bp)

return app
23 changes: 23 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
from app import db

class Planet(db.Model):
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job with this!

id = db.Column(db.Integer, primary_key=True, autoincrement= True)
name = db.Column(db.String)
description = db.Column(db.String)
composition = db.Column(db.String)

@classmethod
def from_dict(cls, data_dict):
return cls(
name=data_dict["name"],
description=data_dict["description"],
composition=data_dict["composition"]
)

def to_dict(self):
return dict(
id=self.id,
name=self.name,
description=self.description,
composition=self.composition
)
2 changes: 0 additions & 2 deletions app/routes.py

This file was deleted.

108 changes: 108 additions & 0 deletions app/routes/routes.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
from flask import Blueprint, jsonify, make_response, request
from app.models.planet import Planet
from app import db
from .routes_helpers import validate_model

# planets = [
# Planet(1, "Mercury", "dark gray", "terrestrial"),
# Planet(2, "Venus", "light yellow", "terrestrial"),
# Planet(3, "Earth", "blue and green", "terrestrial"),
# Planet(4, "Mars", "red", "terrestrial"),
# Planet(5, "Jupiter", "orange and brown", "gas giant")
# ]

bp = Blueprint("planets", __name__, url_prefix="/planets")
# @bp.route("",methods=["GET"])

# # helper function
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, get in the habit of deleting commented out code.

# def validate_planet(planet_id):
# try:
# planet_id = int(planet_id)
# except:
# abort(make_response({"message": f"planet {planet_id} not valid"}, 400))

# planet = Planet.query.get(planet_id)

# if not planet:
# abort(make_response({"message": f"planet {planet_id} not found"}, 404))

# return planet

# routes
@bp.route("/<id>", methods=["GET"])
def get_one_planet(id):
planet = validate_model(Planet, id)

return planet.to_dict(), 200

@bp.route("/<id>", methods =["PUT"])
def update_one_planet(id):
planet = validate_model(Planet,id)
request_body = request.get_json()

planet.name = request_body["name"]
planet.description = request_body["description"]
planet.composition = request_body["composition"]

db.session.commit()

return make_response(f"Planet {planet.name} successfully updated", 200)

@bp.route("/<id>", methods = ["DELETE"])
def delete_one_planet(id):
planet = validate_model(Planet,id)

db.session.delete(planet)
db.session.commit()

return make_response(f"Planet {planet.name} successfully deleted", 200)

@bp.route("", methods=["POST"])
def create_planet():
request_body=request.get_json()

# new_planet = Planet(
# name=request_body["name"],
# description=request_body["description"],
# composition=request_body["composition"]
# )
new_planet = Planet.from_dict(request_body)

db.session.add(new_planet)
db.session.commit()

return make_response(f"Planet {new_planet.name} successfully created", 201)

@bp.route("", methods=["GET"])
def get_all_planets():
planets = Planet.query.all()
planets_list = []
for planet in planets:
planets_list.append(planet.to_dict())

return jsonify(planets_list), 200

# @bp.route("", methods=["GET"])
# def handle_planets():
# planets_response = []
# for planet in planets:
# planets_response.append({
# "id": planet.id,
# "name": planet.name,
# "description": planet.description,
# "chemical composition": planet.composition
# })
# return jsonify(planets_response)

# def make_dict(planet):
# return dict(
# id = planet.id,
# name= planet.name,
# description= planet.description,
# composition= planet.composition
# )

# @bp.route("/<planet_id>", methods = ["GET"])
# def handle_planet(planet_id):
# planet = validate_planet(planet_id)
# return make_dict(planet)
16 changes: 16 additions & 0 deletions app/routes/routes_helpers.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from flask import abort, make_response

# HELPER FUNCTION
def validate_model(cls, id):
try:
id = int(id)
except:
abort(make_response({"message": f"{id} was invalid"}, 400))

model = cls.query.get(id)

if not model:
abort(make_response(
{"message": f"{cls.__name__} with id {id} was not found"}, 404))

return model
8 changes: 6 additions & 2 deletions coworking_agreement.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@ Talk through each section with your partner. Add notes on what you discussed and

## Accessibility Needs
*What does each team member need access to in order to succeed and show up the best they can?*
Go slowly together through instructions, screen share as much as possible

## Collaboration vs. individual work expectations
*Clarify your collaboration expectations- does your group want to write code together all of the time? Or divide work to do independently, then come together to share accomplishments? What tools and technologies can help your collaboration?*
Work independently, collaborate on zoom as much as needed

## Learning Style
*How does each team member learn best in project settings?*
refer to Q2

## Preferred Feedback Style
*How does each team member best receive feedback?*
Included in the collabrating/discussion

## One Team Communication Skill to Improve
*What is a teamwork-related skill you want to work on?*
Expand All @@ -21,5 +25,5 @@ Talk through each section with your partner. Add notes on what you discussed and
*Other co-working agreements that were not captured in the above sections.*

## Signatures
______________ _______________
Date: _________
Aisha Mohamed _______________
Date: 4/24/23
1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
45 changes: 45 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# A generic, single database configuration.

[alembic]
# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s

# set to 'true' to run the environment during
# the 'revision' command, regardless of autogenerate
# revision_environment = false


# Logging configuration
[loggers]
keys = root,sqlalchemy,alembic

[handlers]
keys = console

[formatters]
keys = generic

[logger_root]
level = WARN
handlers = console
qualname =

[logger_sqlalchemy]
level = WARN
handlers =
qualname = sqlalchemy.engine

[logger_alembic]
level = INFO
handlers =
qualname = alembic

[handler_console]
class = StreamHandler
args = (sys.stderr,)
level = NOTSET
formatter = generic

[formatter_generic]
format = %(levelname)-5.5s [%(name)s] %(message)s
datefmt = %H:%M:%S
96 changes: 96 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
from __future__ import with_statement

import logging
from logging.config import fileConfig

from sqlalchemy import engine_from_config
from sqlalchemy import pool
from flask import current_app

from alembic import context

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config

# Interpret the config file for Python logging.
# This line sets up loggers basically.
fileConfig(config.config_file_name)
logger = logging.getLogger('alembic.env')

# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
config.set_main_option(
'sqlalchemy.url',
str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%'))
target_metadata = current_app.extensions['migrate'].db.metadata

# other values from the config, defined by the needs of env.py,
# can be acquired:
# my_important_option = config.get_main_option("my_important_option")
# ... etc.


def run_migrations_offline():
"""Run migrations in 'offline' mode.

This configures the context with just a URL
and not an Engine, though an Engine is acceptable
here as well. By skipping the Engine creation
we don't even need a DBAPI to be available.

Calls to context.execute() here emit the given string to the
script output.

"""
url = config.get_main_option("sqlalchemy.url")
context.configure(
url=url, target_metadata=target_metadata, literal_binds=True
)

with context.begin_transaction():
context.run_migrations()


def run_migrations_online():
"""Run migrations in 'online' mode.

In this scenario we need to create an Engine
and associate a connection with the context.

"""

# this callback is used to prevent an auto-migration from being generated
# when there are no changes to the schema
# reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
def process_revision_directives(context, revision, directives):
if getattr(config.cmd_opts, 'autogenerate', False):
script = directives[0]
if script.upgrade_ops.is_empty():
directives[:] = []
logger.info('No changes in schema detected.')

connectable = engine_from_config(
config.get_section(config.config_ini_section),
prefix='sqlalchemy.',
poolclass=pool.NullPool,
)

with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=target_metadata,
process_revision_directives=process_revision_directives,
**current_app.extensions['migrate'].configure_args
)

with context.begin_transaction():
context.run_migrations()


if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online()
24 changes: 24 additions & 0 deletions migrations/script.py.mako
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""${message}

Revision ID: ${up_revision}
Revises: ${down_revision | comma,n}
Create Date: ${create_date}

"""
from alembic import op
import sqlalchemy as sa
${imports if imports else ""}

# revision identifiers, used by Alembic.
revision = ${repr(up_revision)}
down_revision = ${repr(down_revision)}
branch_labels = ${repr(branch_labels)}
depends_on = ${repr(depends_on)}


def upgrade():
${upgrades if upgrades else "pass"}


def downgrade():
${downgrades if downgrades else "pass"}
Loading