Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
485c041
wave 1 complete
reneesu99 Oct 21, 2022
d423722
Read and handle an existing planet
SemharTes Oct 24, 2022
c0ccf2b
handled non- existing and invalid planets
SemharTes Oct 24, 2022
74e72e7
modified return statments for non-exsting and invalid planet
SemharTes Oct 24, 2022
c00bad9
refactored routes functions into helper functions
reneesu99 Oct 24, 2022
89f2e7c
refactored wave-2 function
SemharTes Oct 25, 2022
63cea2e
got rid of imports
reneesu99 Oct 25, 2022
ac44af3
created a module
SemharTes Oct 28, 2022
1ece771
added get method to planets
reneesu99 Oct 28, 2022
1c04d5b
Merge pull request #1 from reneesu99/read_all_planets
reneesu99 Oct 31, 2022
2bc78b9
read a planet and handled 400 and 404 errors for invalid ad non-exist…
SemharTes Nov 1, 2022
6477e8e
added put and delete methods for one planet, refactored to put it int…
reneesu99 Nov 1, 2022
02c35d1
refactored and added query param moons
reneesu99 Nov 2, 2022
dd38ce4
Merge pull request #2 from reneesu99/renee_wave_5
reneesu99 Nov 2, 2022
3dea5d3
created class method and refactored creating a Planet model in create…
SemharTes Nov 3, 2022
f92bcc6
created .env file and populated 2 env variables in it, refactored cre…
SemharTes Nov 3, 2022
1dbdd31
finished wave 6
reneesu99 Nov 3, 2022
c741d04
Merge branch 'main' into renee_wave_5
reneesu99 Nov 3, 2022
873a96a
resolved merge conflicts
reneesu99 Nov 3, 2022
462f244
Merge pull request #3 from reneesu99/renee_wave_5
reneesu99 Nov 3, 2022
75f0a40
added gunicorn to requirements.txt
SemharTes Nov 7, 2022
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
31 changes: 30 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
from dotenv import load_dotenv
import os


db = SQLAlchemy() # db and migrate are variables that gives us access to db operations
migrate = Migrate()

load_dotenv()

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

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
app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get(
"SQLALCHEMY_TEST_DATABASE_URI")

# connects db & migrate to flask app
from app.models.planet import Planet

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


from .routes import planet_bp
app.register_blueprint(planet_bp)

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


# MODELS are classes that inherit from db.Model from sqlalchemy
class Planet(db.Model): # defining the planet model
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String) # attribute title which will map to a db column
description = db.Column(db.String)
moons = db.Column(db.Integer)

def to_dict(self):
return {
"name": self.name,
"description": self.description,
"moons": self.moons,
"id": self.id,
}

@classmethod
def from_dict(cls, planet_data):
planet_1 = Planet(
name=planet_data["name"],
description=planet_data["description"],
moons=planet_data["moons"]
)
return planet_1
Comment on lines +11 to +26

Choose a reason for hiding this comment

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

👍 nice helper functions

50 changes: 50 additions & 0 deletions app/planets.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# from flask import jsonify, abort, make_response

Choose a reason for hiding this comment

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

You can probably delete this file


# class Planet:
# def __init__(self, id, name, description):
# self.id = id
# self.name = name
# self.description = description

# # instance = an instance of the object
# jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet")
# mars = Planet(id= 2, name = "Mars", description="its close to the sun?")
# mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?")
# venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?")
# earth = Planet(id=5, name = "Earth", description = "us!")
# saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?")
# uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one")
# neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!")
# pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" )
# list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto]

# def return_all_planets():
# planets_json = []
# for planet in list_of_planets:
# dict = {
# "id": planet.id,
# "name": planet.name,
# "description": planet.description
# }
# planets_json.append(dict)
# return jsonify(planets_json)

# def verify_planet(planet_id):
# try:
# planet_id = int(planet_id)
# except:
# abort(make_response ({"Message": f"Planet {planet_id} invalid."}, 400))

# for planet in list_of_planets:
# if planet.id == planet_id:
# return {
# "id": planet.id,
# "name": planet.name,
# "description": planet.description
# }
# abort(make_response({"Message": f"Planet {planet_id} not found."}, 404))





65 changes: 64 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,65 @@
from flask import Blueprint
from app import db
from app.models.planet import Planet
from flask import Blueprint, jsonify, make_response, request, abort

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

@planet_bp.route("", methods=["POST", "GET"])
def handle_planets():
if request.method == "POST":
request_body = request.get_json()

Choose a reason for hiding this comment

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

Doing some validation here on the request body would be appropriate (make sure it has the required fields).

planet_1 = Planet.from_dict(request_body)
db.session.add(planet_1)
db.session.commit()

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

elif request.method == "GET":
moons_param = request.args.get("moons")
if moons_param:
planets = Planet.query.filter_by(moons = moons_param)
else:
planets= Planet.query.all()
response_body = [planet.to_dict() for planet in planets]

Choose a reason for hiding this comment

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

I like the list comprehension here and use of the to_dict method.

return jsonify(response_body), 200


def validate_id(id, cls):
try:
id = int(id)
except:
abort(make_response ({"Message": f"{cls.__name__} {id} invalid."}, 400))

# to access a planet with planet_id in our db, we use
obj = cls.query.get(id)
if not obj:
abort(make_response({"Message": f"{cls.__name__} {id} not found."}, 404))
return obj
Comment on lines +27 to +37

Choose a reason for hiding this comment

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

Good helper



@planet_bp.route("/<planet_id>", methods=["GET", "PUT", "DELETE"])
def handle_one_planet(planet_id):
planet = validate_id(planet_id, Planet)
if request.method == "GET":
return planet.to_dict()

elif request.method == "PUT":
request_body = request.get_json()

Choose a reason for hiding this comment

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

Validating the request body would be good here.


#updating the attributes
planet.name = request_body["name"]
planet.description = request_body["description"]
planet.moons = request_body["moons"]

# commit changes to our db
db.session.commit()

return make_response(f"Planet #{planet_id} is updated.")

elif request.method == "DELETE":
db.session.delete(planet)
db.session.commit()

return make_response(f"Planet #{planet_id} is deleted.")


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"}
34 changes: 34 additions & 0 deletions migrations/versions/48a8fe91a2d5_added_a_planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""added a planet

Revision ID: 48a8fe91a2d5
Revises:
Create Date: 2022-10-28 14:11:25.119178

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '48a8fe91a2d5'
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('moons', sa.Integer(), nullable=True),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('planet')
# ### end Alembic commands ###
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ click==7.1.2
Flask==1.1.2
Flask-Migrate==2.6.0
Flask-SQLAlchemy==2.4.4
gunicorn==20.1.0
idna==2.10
itsdangerous==1.1.0
Jinja2==2.11.3
Expand Down
Empty file added tests/__init__.py
Empty file.
Loading