2 lines
18 KiB
Plaintext
2 lines
18 KiB
Plaintext
|
|
"smart_sources:000-inbox/clippings/2023/04/Steamship Documentation.md": {"path":"000-inbox/clippings/2023/04/Steamship Documentation.md","last_embed":{"hash":null},"embeddings":{},"last_read":{"hash":"bdwi9f","at":1766986878406},"class_name":"SmartSource","last_import":{"mtime":1681692047000,"size":14477,"at":1766986878957,"hash":"bdwi9f"},"blocks":{"#---frontmatter---":[1,5],"#":[6,11],"##Steamship[#](https://docs.steamship.com/#steamship \"Permalink to this heading\")":[12,17],"##Steamship[#](https://docs.steamship.com/#steamship \"Permalink to this heading\")#{1}":[14,17],"##Steamship in 30 seconds[#](https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\")":[18,30],"##Steamship in 30 seconds[#](https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\")#{1}":[20,21],"##Steamship in 30 seconds[#](https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\")#{2}":[22,23],"##Steamship in 30 seconds[#](https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\")#{3}":[24,25],"##Steamship in 30 seconds[#](https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\")#{4}":[26,28],"##Steamship in 30 seconds[#](https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\")#{5}":[29,30],"##Start from a template[#](https://docs.steamship.com/#start-from-a-template \"Permalink to this heading\")":[31,46],"##Start from a template[#](https://docs.steamship.com/#start-from-a-template \"Permalink to this heading\")#{1}":[33,46],"##Start from scratch[#](https://docs.steamship.com/#start-from-scratch \"Permalink to this heading\")":[47,65],"##Start from scratch[#](https://docs.steamship.com/#start-from-scratch \"Permalink to this heading\")#{1}":[49,65],"##Next Steps[#](https://docs.steamship.com/#next-steps \"Permalink to this heading\")":[66,79],"##Next Steps[#](https://docs.steamship.com/#next-steps \"Permalink to this heading\")#{1}":[68,79],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")":[80,196],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{1}":[82,96],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{2}":[97,107],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{3}":[108,113],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{4}":[114,132],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{5}":[133,133],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{6}":[134,134],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{7}":[135,135],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{8}":[136,163],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{9}":[164,194],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{10}":[195,195],"##Contents[#](https://docs.steamship.com/#contents \"Permalink to this heading\")#{11}":[196,196]},"outlinks":[{"title":"Back to top","target":"https://docs.steamship.com/#","line":6},{"title":"Edit this page","target":"https://github.com/steamship-core/python-client/edit/main/docs/index.rst \"Edit this page\"","line":8},{"title":"#","target":"https://docs.steamship.com/#steamship \"Permalink to this heading\"","line":12},{"title":"Steamship package","target":"https://www.steamship.com/packages","line":16},{"title":"#","target":"https://docs.steamship.com/#steamship-in-30-seconds \"Permalink to this heading\"","line":18},{"title":"Use Plugins","target":"https://docs.steamship.com/plugins/using/index.html#using-plugins","line":20},{"title":"Store data in Files, Blocks, and Tags","target":"https://docs.steamship.com/data/index.html#data-model","line":22},{"title":"query","target":"https://docs.steamship.com/data/queries/index.html#queries","line":22},{"title":"search","target":"https://docs.steamship.com/embedding-search/index.html#embedding-search-index","line":22},{"title":"Deploy as a Package","target":"https://docs.steamship.com/packages/developing/index.html#developing-packages","line":24},{"title":"Create as many instances of the Package","target":"https://docs.steamship.com/packages/developing/index.html#creating-package-instances","line":26},{"title":"#","target":"https://docs.steamship.com/#start-from-a-template \"Permalink to this heading\"","line":31},{"title":"https://github.com/steamship-packages","target":"https://github.com/steamship-packages","line":33},{"title":"#","target":"https://docs.steamship.com/#start-from-scratch \"Permalink to this heading\"","line":47},{"title":"#","target":"https://docs.steamship.com/#next-steps \"Permalink to this heading\"","line":66},{"title":"#","target":"https://docs.steamship.com/#contents \"Permalink to this heading\"","line":80},{"title":"Configuration","target":"https://docs.steamship.com/configuration/index.html","line":82},{"title":"Authentication","target":"https://docs.steamship.com/configuration/authentication.html","line":83},{"title":"Steamship Configuration File","target":"https://docs.steamship.com/configuration/authentication.html#steamship-configuration-file","line":84},{"title":"Using Multiple Profiles","target":"https://docs.steamship.com/configuration/authentication.html#using-multiple-profiles","line":85},{"title":"Environment Variables","target":"https://docs.steamship.com/configuration/authentication.html#environment-variables","line":86},{"title":"Client Libraries","target":"https://docs.steamship.com/configuration/clients.html","line":87},{"title":"Python Client","target":"https://docs.steamship.com/configuration/clients.html#python-client","line":88},{"title":"Typescript Client","target":"https://docs.steamship.com/configuration/clients.html#typescript-client","line":89},{"title":"CLI","target":"https://docs.steamship.com/configuration/cli.html","line":90},{"title":"HTTP API","target":"https://docs.steamship.com/configuration/http.html","line":91},{"title":"Requests","target":"https://docs.steamship.com/configuration/http.html#requests","line":92},{"title":"Optional Headers","target":"https://docs.steamship.com/configuration/http.html#optional-headers","line":93},{"title":"Engine Response Format","target":"https://docs.steamship.com/configuration/http.html#engine-response-format","line":94},{"title":"Creating a Package Instance","target":"https://docs.steamship.com/configuration/http.html#creating-a-package-instance","line":95},{"title":"Invoking a Package Method","target":"https://docs.steamship.com/configuration/http.html#invoking-a-package-method","line":96},{"title":"Packages","target":"https://docs.steamship.com/packages/index.html","line":97},{"title":"Packages Table of Contents","target":"https://docs.steamship.com/packages/index.html#packages-table-of-contents","line":98},{"title":"Using Packages","target":"https://docs.steamship.com/packages/using.html","line":99},{"title":"Package FAQ","target":"https://docs.steamship.com/packages/using.html#package-faq","line":100},{"title":"Developing Packages","target":"https://docs.steamship.com/packages/developing/index.html","line":101},{"title":"Customizing your Package","target":"https://docs.steamship.com/packages/developing/index.html#customizing-your-package","line":102},{"title":"Package Project Structure","target":"https://docs.steamship.com/packages/developing/project-structure.html","line":103},{"title":"Package Cookbook","target":"https://docs.steamship.com/packages/cookbook/index.html","line":104},{"title":"Working with Language","target":"https://docs.steamship.com/packages/cookbook/index.html#working-with-language","line":105},{"title":"Building Packages","target":"https://docs.steamship.com/packages/cookbook/index.html#building-packages","line":106},{"title":"Response Types","target":"https://docs.steamship.com/packages/cookbook/index.html#response-types","line":107},{"title":"Plugins","target":"https://docs.steamship.com/plugins/index.html","line":108},{"title":"File Importers","target":"https://docs.steamship.com/plugins/index.html#file-importers","line":109},{"title":"Blockifiers","target":"https://docs.steamship.com/plugins/index.html#blockifiers","line":110},{"title":"Taggers","target":"https://docs.steamship.com/plugins/index.html#taggers","line":111},{"title":"Generators","target":"https://docs.steamship.com/plugins/index.html#generators","line":112},{"title":"Embedders","target":"https://docs.steamship.com/plugins/index.html#embedders","line":113},{"title":"Data","target":"https://docs.steamship.com/data/index.html","line":114},{"title":"Workspaces","target":"https://docs.steamship.com/data/workspaces.html","line":115},{"title":"Creating Workspaces","target":"https://docs.steamship.com/data/workspaces.html#creating-workspaces","line":116},{"title":"Files","target":"https://docs.steamship.com/data/files.html","line":117},{"title":"Creating Files Directly","target":"https://docs.steamship.com/data/files.html#creating-files-directly","line":118},{"title":"Blocks","target":"https://docs.steamship.com/data/blocks.html","line":119},{"title":"Creating Blocks","target":"https://docs.steamship.com/data/blocks.html#id2","line":120},{"title":"Tags","target":"https://docs.steamship.com/data/tags.html","line":121},{"title":"Ways to use Tags","target":"https://docs.steamship.com/data/tags.html#ways-to-use-tags","line":122},{"title":"Tag Schemas","target":"https://docs.steamship.com/data/tags.html#tag-schemas","line":123},{"title":"Block and File Tags","target":"https://docs.steamship.com/data/tags.html#block-and-file-tags","line":124},{"title":"Querying Data","target":"https://docs.steamship.com/data/queries/index.html","line":125},{"title":"Usage","target":"https://docs.steamship.com/data/queries/index.html#usage","line":126},{"title":"Language Description","target":"https://docs.steamship.com/data/queries/index.html#language-description","line":127},{"title":"Unary Predicates","target":"https://docs.steamship.com/data/queries/index.html#unary-predicates","line":128},{"title":"Binary Predicates","target":"https://docs.steamship.com/data/queries/index.html#binary-predicates","line":129},{"title":"Binary Relations","target":"https://docs.steamship.com/data/queries/index.html#binary-relations","line":130},{"title":"Conjunctions","target":"https://docs.steamship.com/data/queries/index.html#conjunctions","line":131},{"title":"Special Predicates","target":"https://docs.steamship.com/data/queries/index.html#special-predicates","line":132},{"title":"Embedding Search Index","target":"https://docs.steamship.com/embedding-search/index.html","line":133},{"title":"Inserting Data","target":"https://docs.steamship.com/embedding-search/index.html#inserting-data","line":134},{"title":"Querying Data","target":"https://docs.steamship.com/embedding-search/index.html#querying-data","line":135},{"title":"Developer Reference","target":"https://docs.steamship.com/developing/index.html","line":136},{"title":"Cloning a Starter Project","target":"https://docs.steamship.com/developing/project-creation.html","line":137},{"title":"The Steamship Manifest file","target":"https://docs.steamship.com/developing/steamship-manifest.html","line":138},{"title":"Plugin Configuration","target":"https://docs.steamship.com/developing/steamship-manifest.html#plugin-configuration","line":139},{"title":"Steamship Registry","target":"https://docs.steamship.com/developing/steamship-manifest.html#steamship-registry","line":140},{"title":"Python Environment Setup","target":"https://docs.steamship.com/developing/environment-setup.html","line":141},{"title":"Accepting Configuration","target":"https://docs.steamship.com/developing/configuration.html","line":142},{"title":"Defining and Accepting configuration in your code","target":"https://docs.steamship.com/developing/configuration.html#defining-and-accepting-configuration-in-your-code","line":143},{"title":"Storing Secrets","target":"https://docs.steamship.com/developing/storing-secrets.html","line":144},{"title":"Writing Tests","target":"https://docs.steamship.com/developing/testing.html","line":145},{"title":"Logging","target":"https://docs.steamship.com/developing/testing.html#logging","line":146},{"title":"Throwing Errors","target":"https://docs.steamship.com/developing/testing.html#throwing-errors","line":147},{"title":"Manual Testing","target":"https://docs.steamship.com/developing/testing.html#manual-testing","line":148},{"title":"Automated testing","target":"https://docs.steamship.com/developing/testing.html#automated-testing","line":149},{"title":"Automated testing setup","target":"https://docs.steamship.com/developing/testing.html#automated-testing-setup","line":150},{"title":"Modifying or removing automated testing","target":"https://docs.steamship.com/developing/testing.html#modifying-or-removing-automated-testing","line":151},{"title":"Deploying","target":"https://docs.steamship.com/developing/deploying.html","line":152},{"title":"Deploying with the Steamship CLI","target":"https://docs.steamship.com/developing/deploying.html#deploying-with-the-steamship-cli","line":153},{"title":"Deploying via GitHub Actions","target":"https://docs.steamship.com/developing/deploying.html#deploying-via-github-actions","line":154},{"title":"Automated Deployment Setup","target":"https://docs.steamship.com/developing/deploying.html#automated-deployment-setup","line":155},{"title":"Modifying or disabling automated deployments","target":"https://docs.steamship.com/developing/deploying.html#modifying-or-disabling-automated-deployments","line":156},{"title":"Troubleshooting Deployments","target":"https://docs.steamship.com/developing/deploying.html#troubleshooting-deployments","line":157},{"title":"The deployment fails because the version already exists","target":"https://docs.steamship.com/developing/deploying.html#the-deployment-fails-because-the-version-already-exists","line":158},{"title":"The deployment fails because the tag does not match the manifest file","target":"https://docs.steamship.com/developing/deploying.html#the-deployment-fails-because-the-tag-does-not-match-the-manifest-file","line":159},{"title":"The deployment fails with an authentication error","target":"https://docs.steamship.com/developing/deploying.html#the-deployment-fails-with-an-authentication-error","line":160},{"title":"Updating your Web Listing","target":"https://docs.steamship.com/developing/updating-web-listing.html","line":161},{"title":"Updating your Web Listing","target":"https://docs.steamship.com/developing/updating-web-listing.html#updating-your-web-listing","line":162},{"title":"Adding taglines, demo links, and author icons","target":"https://docs.steamship.com/developing/updating-web-listing.html#adding-taglines-demo-links-and-author-icons","line":163},{"title":"Python Client Reference","target":"https://docs.steamship.com/api/modules.html","line":164},{"title":"steamship package","target":"https://docs.steamship.com/api/steamship.html","line":165},{"title":"Subpackages","target":"https://docs.steamship.com/api/steamship.html#subpackages","line":166},{"title":"steamship.base package","target":"https://docs.steamship.com/api/steamship.base.html","line":167},{"title":"steamship.cli package","target":"https://docs.steamship.com/api/steamship.cli.html","line":168},{"title":"steamship.client package","target":"https://docs.steamship.com/api/steamship.client.html","line":169},{"title":"steamship.data package","target":"https://docs.steamship.com/api/steamship.data.html","line":170},{"title":"steamship.experimental package","target":"https://docs.steamship.com/api/steamship.experimental.html","line":171},{"title":"steamship.invocable package","target":"https://docs.steamship.com/api/steamship.invocable.html","line":172},{"title":"steamship.plugin package","target":"https://docs.steamship.com/api/steamship.plugin.html","line":173},{"title":"steamship.utils package","target":"https://docs.steamship.com/api/steamship.utils.html","line":174},{"title":"Module contents","target":"https://docs.steamship.com/api/steamship.html#module-steamship","line":175},{"title":"`Block`","target":"https://docs.steamship.com/api/steamship.html#steamship.Block","line":176},{"title":"`Configuration`","target":"https://docs.steamship.com/api/steamship.html#steamship.Configuration","line":177},{"title":"`DocTag`","target":"https://docs.steamship.com/api/steamship.html#steamship.DocTag","line":178},{"title":"`EmbeddingIndex`","target":"https://docs.steamship.com/api/steamship.html#steamship.EmbeddingIndex","line":179},{"title":"`File`","target":"https://docs.steamship.com/api/steamship.html#steamship.File","line":180},{"title":"`MimeTypes`","target":"https://docs.steamship.com/api/steamship.html#steamship.MimeTypes","line":181},{"title":"`Package`","target":"https://docs.steamship.com/api/steamship.html#steamship.Package","line":182},{"title":"`PackageInstance`","target":"https://docs.steamship.com/api/steamship.html#steamship.PackageInstance","line":183},{"title":"`PackageVersion`","target":"https://docs.steamship.com/api/steamship.html#steamship.PackageVersion","line":184},{"title":"`PluginInstance`","target":"https://docs.steamship.com/api/steamship.html#steamship.PluginInstance","line":185},{"title":"`PluginVersion`","target":"https://docs.steamship.com/api/steamship.html#steamship.PluginVersion","line":186},{"title":"`RuntimeEnvironments`","target":"https://docs.steamship.com/api/steamship.html#steamship.RuntimeEnvironments","line":187},{"title":"`Steamship`","target":"https://docs.steamship.com/api/steamship.html#steamship.Steamship","line":188},{"title":"`SteamshipError`","target":"https://docs.steamship.com/api/steamship.html#steamship.SteamshipError","line":189},{"title":"`Tag`","target":"https://docs.steamship.com/api/steamship.html#steamship.Tag","line":190},{"title":"`Task`","target":"https://docs.steamship.com/api/steamship.html#steamship.Task","line":191},{"title":"`TaskState`","target":"https://docs.steamship.com/api/steamship.html#steamship.TaskState","line":192},{"title":"`Workspace`","target":"https://docs.steamship.com/api/steamship.html#steamship.Workspace","line":193},{"title":"`check_environment()`","target":"https://docs.steamship.com/api/steamship.html#steamship.check_environment","line":194},{"title":"License","target":"https://docs.steamship.com/license.html","line":195},{"title":"Authors","target":"https://docs.steamship.com/authors.html","line":196}],"metadata":{"page-title":"Steamship Documentation","url":"https://docs.steamship.com/","date":"2023-04-17 08:40:46"},"task_lines":[],"tasks":{},"codeblock_ranges":[]}, |