{"id":135291,"date":"2024-09-05T16:01:27","date_gmt":"2024-09-05T10:31:27","guid":{"rendered":"https:\/\/www.vskills.in\/certification\/tutorial\/?page_id=135291"},"modified":"2024-09-05T16:01:28","modified_gmt":"2024-09-05T10:31:28","slug":"setting-up-the-initial-app","status":"publish","type":"page","link":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/","title":{"rendered":"Setting Up the Initial App"},"content":{"rendered":"\n<p>In this guide, we&#8217;ll understand the process of setting up your FastAPI application. We&#8217;ll explore how to structure your project, create environment files, and manage dependencies using tools like <code class=\"\">poetry<\/code>. By the end of this section, you&#8217;ll have a well-organized foundation for building your API.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Project Structure<\/strong><\/h2>\n\n\n\n<p>A typical FastAPI project structure might look like this:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>project_name\/\n\u251c\u2500\u2500 app\/\n\u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u251c\u2500\u2500 main.py\n\u2502   \u251c\u2500\u2500 models.py\n\u2502   \u2514\u2500\u2500 routes.py\n\u251c\u2500\u2500 tests\/\n\u251c\u2500\u2500 .gitignore\n\u251c\u2500\u2500 poetry.lock\n\u251c\u2500\u2500 pyproject.toml\n<\/code><\/pre>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong><code>app<\/code> directory:<\/strong> This is where your main application code will reside.<\/li>\n\n\n\n<li><strong><code>main.py<\/code>:<\/strong> The entry point for your application.<\/li>\n\n\n\n<li><strong><code>models.py<\/code>:<\/strong> Defines data models for your API.<\/li>\n\n\n\n<li><strong><code>routes.py<\/code>:<\/strong> Contains your path operations and routing logic.<\/li>\n\n\n\n<li><strong><code>tests<\/code> directory:<\/strong> For writing unit and integration tests.<\/li>\n\n\n\n<li><strong><code>.gitignore<\/code>:<\/strong> Specifies files and directories to exclude from Git version control.<\/li>\n\n\n\n<li><strong><code>poetry.lock<\/code>:<\/strong> Stores dependency versions for reproducibility.<\/li>\n\n\n\n<li><strong><code>pyproject.toml<\/code>:<\/strong> A configuration file for <code class=\"\">poetry<\/code>.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Creating a Virtual Environment<\/strong><\/h2>\n\n\n\n<p>To isolate your project&#8217;s dependencies from your system-wide Python environment, create a virtual environment using <code class=\"\">poetry<\/code>:<\/p>\n\n\n\n<p>Bash<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>poetry init\n<\/code><\/pre>\n\n\n\n<p>This will create a <code class=\"\">poetry.lock<\/code> file and a <code class=\"\">pyproject.toml<\/code> file.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Installing Dependencies<\/strong><\/h2>\n\n\n\n<p>Add FastAPI and other required libraries to your <code class=\"\">pyproject.toml<\/code> file:<\/p>\n\n\n\n<p>Ini, TOML<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>&#91;tool.poetry.dependencies]\npython = \"^3.7\"\nfastapi = \"^0.95.0\"\nuvicorn = \"^0.18.0\"\n<\/code><\/pre>\n\n\n\n<p>Then, install them using <code class=\"\">poetry<\/code>:<\/p>\n\n\n\n<p>Bash<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>poetry install\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Creating the Main Application File<\/strong><\/h2>\n\n\n\n<p>Create a <code class=\"\">main.py<\/code> file in your <code class=\"\">app<\/code> directory and import the necessary modules:<\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>from fastapi import FastAPI\n\napp = FastAPI()\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Defining Path Operations<\/strong><\/h2>\n\n\n\n<p>Start defining your API&#8217;s endpoints in the <code class=\"\">routes.py<\/code> file:<\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>from fastapi import APIRouter\n\nrouter = APIRouter()\n\n@router.get(\"\/\")\ndef read_root():\n    return {\"Hello\": \"World\"}\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Importing Routes in the Main File<\/strong><\/h2>\n\n\n\n<p>Import the <code class=\"\">routes.py<\/code> file in your <code class=\"\">main.py<\/code> and include the router:<\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>from app import routes\n\napp.include_router(routes.router)\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Running the Application<\/strong><\/h2>\n\n\n\n<p>To start your application, use <code class=\"\">uvicorn<\/code>:<\/p>\n\n\n\n<p>Bash<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>poetry run uvicorn app.main:app --reload\n<\/code><\/pre>\n\n\n\n<p>This will start the application on the default host and port.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>In this guide, we&#8217;ll understand the process of setting up your FastAPI application. We&#8217;ll explore how to structure your project, create environment files, and manage dependencies using tools like poetry. By the end of this section, you&#8217;ll have a well-organized foundation for building your API. Project Structure A typical FastAPI project structure might look like&#8230;<\/p>\n","protected":false},"author":16,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"categories":[],"tags":[],"class_list":["post-135291","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Setting Up the Initial App - Tutorial<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Setting Up the Initial App - Tutorial\" \/>\n<meta property=\"og:description\" content=\"In this guide, we&#8217;ll understand the process of setting up your FastAPI application. We&#8217;ll explore how to structure your project, create environment files, and manage dependencies using tools like poetry. By the end of this section, you&#8217;ll have a well-organized foundation for building your API. Project Structure A typical FastAPI project structure might look like...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/\" \/>\n<meta property=\"og:site_name\" content=\"Tutorial\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/vskills.in\/\" \/>\n<meta property=\"article:modified_time\" content=\"2024-09-05T10:31:28+00:00\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/\",\"name\":\"Setting Up the Initial App - Tutorial\",\"isPartOf\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#website\"},\"datePublished\":\"2024-09-05T10:31:27+00:00\",\"dateModified\":\"2024-09-05T10:31:28+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Setting Up the Initial App\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#website\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\",\"name\":\"Tutorial\",\"description\":\"Vskills - A initiative in elearning and certification\",\"publisher\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.vskills.in\/certification\/tutorial\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#organization\",\"name\":\"Vskills\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg\",\"contentUrl\":\"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg\",\"width\":73,\"height\":55,\"caption\":\"Vskills\"},\"image\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/vskills.in\/\",\"https:\/\/x.com\/vskills_in\",\"https:\/\/www.linkedin.com\/company-beta\/1371554\/\",\"https:\/\/www.youtube.com\/channel\/UCMWnscxPwRF_PqXo9B7q_Tw\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Setting Up the Initial App - Tutorial","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/","og_locale":"en_US","og_type":"article","og_title":"Setting Up the Initial App - Tutorial","og_description":"In this guide, we&#8217;ll understand the process of setting up your FastAPI application. We&#8217;ll explore how to structure your project, create environment files, and manage dependencies using tools like poetry. By the end of this section, you&#8217;ll have a well-organized foundation for building your API. Project Structure A typical FastAPI project structure might look like...","og_url":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/","og_site_name":"Tutorial","article_publisher":"https:\/\/www.facebook.com\/vskills.in\/","article_modified_time":"2024-09-05T10:31:28+00:00","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/","url":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/","name":"Setting Up the Initial App - Tutorial","isPartOf":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#website"},"datePublished":"2024-09-05T10:31:27+00:00","dateModified":"2024-09-05T10:31:28+00:00","breadcrumb":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/setting-up-the-initial-app\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.vskills.in\/certification\/tutorial\/"},{"@type":"ListItem","position":2,"name":"Setting Up the Initial App"}]},{"@type":"WebSite","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#website","url":"https:\/\/www.vskills.in\/certification\/tutorial\/","name":"Tutorial","description":"Vskills - A initiative in elearning and certification","publisher":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.vskills.in\/certification\/tutorial\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#organization","name":"Vskills","url":"https:\/\/www.vskills.in\/certification\/tutorial\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/","url":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg","contentUrl":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg","width":73,"height":55,"caption":"Vskills"},"image":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/vskills.in\/","https:\/\/x.com\/vskills_in","https:\/\/www.linkedin.com\/company-beta\/1371554\/","https:\/\/www.youtube.com\/channel\/UCMWnscxPwRF_PqXo9B7q_Tw"]}]}},"_links":{"self":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135291","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/users\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/comments?post=135291"}],"version-history":[{"count":2,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135291\/revisions"}],"predecessor-version":[{"id":135301,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135291\/revisions\/135301"}],"wp:attachment":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/media?parent=135291"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/categories?post=135291"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/tags?post=135291"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}