Package: getcite
CONTENTS OF THIS FILE---------------------* Introduction* Requirements* Installation* Functionality* Instructions for Use* License* ContactINTRODUCTION------------getcite was created to save Florida Law Review member's time by automatingthe process called "pulling sources."REQUIREMENTS------------getcite currently has the following software dependencies:Python 3.5.0 or higher;Selenium WebDriver 2.48.0 or higher;Firefox 43 or higher;PyPDF2 1.25.0 or higher;getcite has the following network dependencies:For sources from HeinOnline: must be on local UF network or logged into UF network through VPN;INSTALLATION------------For Mac:(1) Download and install Python 3.5 or above, by going to this website:https://www.python.org/downloads/(2) Once Python is installed, download getcite by opening terminal andtyping:python3 -m pip install getcite --download ~/DownloadsORgit clone https://github.com/salexander2000/getcite(3) Once getcite is downloaded and unzipped, go to the getcite rootfolder (that contains setup.py) and type:python3 setup.py install(4) To run, go to the ./getcite folder and type:python3 getcite.pyFUNCTIONALITY-------------getcite can perform the following actions:Downloading:Any original PDFs, including S. Ct. opinions, on Westlaw, defaultpresumption;Any unpublished/recent cases available on Westlaw, via the Westlawgenerate/download PDF function;Supreme Court cases on HeinOnline, automatically detected;U.S.C. statutes on HeinOnline, automatically detected;Law review articles on HeinOnline, must be specified;Naming:Names automatically downloaded sources in the FLR source-namingformat;Can rename most recently downloaded file, if downloadcompleted manually, in FLR source-naming format;Shepardizing:Cases and statutes on westlaw;Uses auto-naming features;Automatically concatenates PDFs when multiple histories are downloadede.g. cases with both negative treatment and case history;NOTE: As of right now, getcite cannot locate the table of contentsassociated with a law review article. The process is too complex andidiosyncratic.Law review articles often contain enough information on the first pageof the article to determine the accuracy of the citation. However, theyoften do not. In order to make the best of getcite's automation processwhile not dropping required elements of the source-pulling process ingeneral, the following steps are recommended:1) Download the law review article automatically.2) After the source is automatically downloaded and named, look atthe first page, which should be open in Firefox, to see if moreinformation is necessary to verify the accuracy of the citation.3) If the article page contains enough information, move on.Otherwise, you can now quickly find the associated table ofcontents and download it manually.4) Once you've downloaded the table of contents, you'll need tomanually merge it into the properly named file using a PDFeditor.INSTRUCTIONS FOR USE--------------------getcite will automatically attempt to detect the citation type and location.However, the user must first specify that they* intend to enter an articlecitation by using the "article" command.NOTE: There is really no difference between citations and commands. When astring is entered, getcite will first run it through the list of availablecommands. If getcite does not detect a known command, the program will treatthe entry as a citation and attempt to automatically locate and download it.Abbreviation prompts:First, getcite will ask for the EDITOR abbreviation. Next, getcite willask for the AUTHOR abbreviation.This information helps getcite automatically name downloaded sourcesonly needs to be entered once every time getcite runs.Citation prompt and source naming:The user can now start entering citations and commands.Source naming:(1) If getcite successfully downloads a source, the program will prompt theuser to either type a save-name different from the citation entered orsimply press 'enter' to use the citation entered for the save-name. Thisfunctionality was added because reviewers often prefer to use a case orarticle name rather than a case or article citation when naming sourcefiles.The user may also type 'stop' here, which will return the program to thecitation prompt without renaming a file. This is useful when getcite grabsthe wrong file.(2) Next, getcite will ask the user for the footnote number, e.g.: 037(4)NOTE: Because the naming function runs immediately after the footnote isentered, you need to WAIT UNTIL THE DOWNLOAD IS COMPLETE before hitting'return' after entering the footnote number.(3) Finally, getcite will print the most recently downloaded file's name, toensure accuracy, and then will rename that file to an FLR format:author_abbreviation footnote_number name/citation editor_abbreviation.pdfCommands:quit:		Closes the browser and quits getcitearticle: 	Tells getcite that the citation is a Law Review articleUSAGE:	article:118 Harv. L. Rev. 833rename:	Renames the most recently modified file in the downloadfolder. getcite assumes that the the most recently modifiedfile in that folder is the most recently downloaded file, soavoid modifying (e.g. renaming) files while getcite isoperatingUSAGE: 		rename:name of case or article:footnote_numberFor example: 	rename:Shakur v. Smalls:003(4)Assuming EDITOR abb. is AB and AUTHOR abb. is CD,, getcitewill save the most recently downloaded file in the downloadfolder as:CD 003(4) Shakur v. Smalls AB.pdfThis command is helpful when:(a) the user has reached a point where getcite cannot downloadthe source, but the user can finish the download manually.After the manual download is completed, getcite's "rename"function is still faster than using the operating system.(b) the user has not used getcite for the most recent download,but has manually downloaded a source into the download folderand wishes to use the rename function rather than renamingthrough the operating system;(c) the user has made a mistake in the naming of the mostrecently automatically-downloaded file, and wishes to name itagain. For example, user enters 012 for footnote, but wants tochange it to 012(1) without using the operating system;history:    Finds the westlaw history of the case or statute specified.USAGE:      history:citationBy simply typing "history," with no argument, the user canimpute the previously entered citation as the argument. Usefulfor when the history the user wants is from the previouslydownloaded case.merge:		Merges two files: the most recent in Sources and the mostrecent in Downloads.USAGE:  (1) Download an article, enter name, footnote.(2) Manually download ToC from HeinOnline. Leavein Downloads directory.(3) Use "merge" command to concatenate these two files.license:     Displays a shortened version of the getcite license.warranty:    Displays the getcite warranty.help: 		  Displays the help screenLICENSE-------Copyright (C) 2015This program is free software: you can redistribute it and/or modify it underthe terms of the GNU General Public License as published by the Free SoftwareFoundation, either version 3 of the License, or (at your option) any laterversion.This program is distributed in the hope that it will be useful, but WITHOUTANY WARRANTY; without even the implied warranty of MERCHANTABILITY orFITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License formore details.You should have received a copy of the GNU General Public License along withthis program.  If not, see <http://www.gnu.org/licenses/>.CONTACT-------You can contact the author at: salexander2000@gmail.com