{"__v":12,"_id":"54d3e371514a230d0018195a","category":{"__v":10,"_id":"5477c47ef3736008009e9eb7","pages":["5477c4dbf3736008009e9eb9","5477c545f3736008009e9ebc","54d36f225616470d0013ccf9","54d372fa69578e0d0027311f","54d3e371514a230d0018195a","54d410f79873ad0d00b3793b","54d42ca39873ad0d00b37950","54e9099bf152c50d009b49b5","552c27bb7820b80d00aa4ede","5570b1829ea7860d008b272f"],"project":"5476bf0f817e8d080031f988","version":"5476bf10817e8d080031f98b","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-28T00:40:30.938Z","from_sync":false,"order":5,"slug":"packages","title":"Packages"},"parentDoc":null,"project":"5476bf0f817e8d080031f988","user":"54c2cebe2c88ef0d00aa2910","version":{"__v":17,"_id":"5476bf10817e8d080031f98b","project":"5476bf0f817e8d080031f988","createdAt":"2014-11-27T06:05:04.263Z","releaseDate":"2014-11-27T06:05:04.263Z","categories":["5476bf10817e8d080031f98c","5477c46cf3736008009e9eb5","5477c474f3736008009e9eb6","5477c47ef3736008009e9eb7","5477c48ff3736008009e9eb8","5477c4948deb230800808bf0","54e68328154f8e0d0007b55c","54e90194c8e0c00d007ac061","54eed2275bf74a0d00ef4076","54f7a7be0a3cbb0d00d666fb","559b0ebf7ae7f80d0096d871","55d697f9ae529e0d00d34f03","562d4dcc8c6e5a0d00d6ed1d","562e591c4376430d006f17e0","568f0e73bdb9260d00149d8c","5719542aac1e2e0e001834c6","57a14a8ed778850e0047e230"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["551cc6b4077b950d00d1227f"],"next":{"pages":[],"description":""},"createdAt":"2015-02-05T21:41:05.938Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Packages are used to organize a collection of protocols.  A protocol is a Python script that generates autoprotocol.  It is accompanied by a json file, called a manifest, which defines certain properties of the protocol, like a name and a version.  Protocols have a unique name, e.g. 'My Protocol', which identifies them within a Package.   The manifest also contains a version number for the protocol, which is of the format 'Major.Minor.Patch', for example '1.0.0'.  \n\nProtocols are added to a Package by uploading a release.  A release is a zip archive that contains one, or several, protocols.  Transcriptic organizes protocols together by the uniqueness of their name within the Package.  For example, say we upload an initial release that contains a protocol with the name 'My Protocol' with a version '1.0.0'.  To update just this protocol, we can upload a second release that contains a protocol with the same name 'My Protocol' but with an updated version '1.0.1'.  A Release does not have to update all of the protocols within the Package.  It can contain as many, or as few, protocols as you would like to create or update.\n\nWhen one user of an organization uploads a package, it is accessible to other members of that organization.  Only the creator of the Package is able to edit the Package or update protcools.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/oUQZj41SQilsiPyRHdt3_Transcriptic.png\",\n        \"Transcriptic.png\",\n        \"1352\",\n        \"367\",\n        \"#85aece\",\n        \"\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]","excerpt":"Versioned protocols guarantee no unexpected changes.","slug":"what-is-a-package","type":"basic","title":"Intro to Packages and Releases"}

Intro to Packages and Releases

Versioned protocols guarantee no unexpected changes.

Packages are used to organize a collection of protocols. A protocol is a Python script that generates autoprotocol. It is accompanied by a json file, called a manifest, which defines certain properties of the protocol, like a name and a version. Protocols have a unique name, e.g. 'My Protocol', which identifies them within a Package. The manifest also contains a version number for the protocol, which is of the format 'Major.Minor.Patch', for example '1.0.0'. Protocols are added to a Package by uploading a release. A release is a zip archive that contains one, or several, protocols. Transcriptic organizes protocols together by the uniqueness of their name within the Package. For example, say we upload an initial release that contains a protocol with the name 'My Protocol' with a version '1.0.0'. To update just this protocol, we can upload a second release that contains a protocol with the same name 'My Protocol' but with an updated version '1.0.1'. A Release does not have to update all of the protocols within the Package. It can contain as many, or as few, protocols as you would like to create or update. When one user of an organization uploads a package, it is accessible to other members of that organization. Only the creator of the Package is able to edit the Package or update protcools. [block:image] { "images": [ { "image": [ "https://files.readme.io/oUQZj41SQilsiPyRHdt3_Transcriptic.png", "Transcriptic.png", "1352", "367", "#85aece", "" ], "caption": "" } ] } [/block]