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

Sea Turtles Heather M & Jenny C #19

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
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
24 changes: 23 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
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
if not test_config:
app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI")

return app
else:
print("Testing is on")
Copy link

Choose a reason for hiding this comment

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

Was this for testing your code? Or was this intentional so that you know if you are testing?

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

db.init_app(app)
migrate.init_app(app, db)

from .routes import planets_bp
from app.models.planet import Planet
app.register_blueprint(planets_bp)

return app
Empty file added app/models/__init__.py
Empty file.
9 changes: 9 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
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.

🙌🏽

id = db.Column(db.Integer, primary_key=True, autoincrement=True)
order_from_sun = db.Column(db.Integer)
name = db.Column(db.String)
description = db.Column(db.String)
gravity = db.Column(db.String)
101 changes: 100 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,101 @@
from flask import Blueprint
from app import db
from app.models.planet import Planet
from flask import Blueprint, jsonify, make_response, request, abort


planets_bp = Blueprint("planets", __name__, url_prefix="/planets")

@planets_bp.route("/teapot", methods=["GET", "POST"])
def handle_teapot():
return make_response("I'm a teapot!", 418)

Comment on lines +8 to +11
Copy link

Choose a reason for hiding this comment

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

Was this also yall testing some stuff out?

def validate_planet(planet_id):
try:
planet_id = int(planet_id)
except:
abort(make_response({"message":f"Planet {planet_id} invalid"}, 400))

planet = Planet.query.get(planet_id)

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

return planet

@planets_bp.route("/<planet_id>", methods = ["GET"])
def read_one_planet(planet_id):
planet = validate_planet(planet_id)
return {
"id": planet.id,
"order_from_sun": planet.order_from_sun,
"name": planet.name,
"description": planet.description,
"gravity": planet.gravity
}
Comment on lines +28 to +34
Copy link

Choose a reason for hiding this comment

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

in your Planet class you can create an instance method to return this information. Then you can use the instance method over and over again.


@planets_bp.route("", methods=["GET"])
def get_all_planets():
name_query = request.args.get("name")
description_query = request.args.get("description")
order_from_sun_query = request.args.get("order_from_sun")
Comment on lines +38 to +40
Copy link

Choose a reason for hiding this comment

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

I like how you all added different ways to query for the planets

if name_query:
planets = Planet.query.filter_by(name=name_query)
elif description_query:
planets = Planet.query.filter(Planet.description.ilike("%" + description_query + "%"))
elif order_from_sun_query:
planets = Planet.query.filter_by(order_from_sun =order_from_sun_query)
else:
planets = Planet.query.all()

planets_response = []
for planet in planets:
planets_response.append({
"id": planet.id,
"order_from_sun": planet.order_from_sun,
"name": planet.name,
"description": planet.description,
"gravity": planet.gravity
})
Comment on lines +52 to +58
Copy link

Choose a reason for hiding this comment

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

this could also be made an instance method in your Planet class.

return jsonify(planets_response)

@planets_bp.route("", methods=["POST"])
def add_planet():
request_body = request.get_json()
new_planet = Planet(
name=request_body["name"],
order_from_sun=request_body["order_from_sun"],
description=request_body["description"],
gravity=request_body["gravity"])

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

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

@planets_bp.route("/<planet_id>", methods=["PUT"])
def update_planet(planet_id):
planet = validate_planet(planet_id)
request_body = request.get_json()
request_body_keys = request_body.keys()

if "name" in request_body_keys:
planet.name = request_body["name"]
if "description" in request_body_keys:
planet.description = request_body["description"]
if "gravity" in request_body_keys:
planet.gravity = request_body["gravity"]
if "order_from_sun" in request_body_keys:
planet.order_from_sun = request_body["order_from_sun"]

db.session.commit()
return make_response(f"Planet #{planet.id} successfully updated", 200)

@planets_bp.route("/<planet_id>", methods=["DELETE"])
def delete_planet(planet_id):
planet = validate_planet(planet_id)

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

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

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"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""updated planet model to include order

Revision ID: c5672b3cf4c5
Revises: f07136d1f4eb
Create Date: 2022-05-04 11:42:13.063620

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'c5672b3cf4c5'
down_revision = 'f07136d1f4eb'
branch_labels = None
depends_on = None


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.add_column('planet', sa.Column('order_from_sun', sa.Integer(), nullable=True))
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_column('planet', 'order_from_sun')
# ### end Alembic commands ###
34 changes: 34 additions & 0 deletions migrations/versions/f07136d1f4eb_created_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""created planet model

Revision ID: f07136d1f4eb
Revises:
Create Date: 2022-05-03 11:08:22.973995

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'f07136d1f4eb'
down_revision = None
branch_labels = None
depends_on = None


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('planet',
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
sa.Column('name', sa.String(), nullable=True),
sa.Column('description', sa.String(), nullable=True),
sa.Column('gravity', sa.String(), nullable=True),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('planet')
# ### end Alembic commands ###
5 changes: 5 additions & 0 deletions planets.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
order_from_sun, name, description, gravity
3, Earth, something about earth, 9.81 m/s2
2, Venus, Very hot planet with a dense atmosphere, 8.87 m/s2
1, Mercury, Closest planet to the sun, m/s2
4, Mars, Thin atmosphere, m/s2
3 changes: 3 additions & 0 deletions project-directions/wave_02.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ As a client, I want to send a request...
1. ...to get one existing `planet`, so that I can see the `id`, `name`, `description`, and other data of the `planet`.
1. ... such that trying to get one non-existing `planet` responds with get a `404` response, so that I know the `planet` resource was not found.
1. ... such that trying to get one `planet` with an invalid `planet_id` responds with get a `400` response, so that I know the `planet_id` was invalid.




Loading