Difference between revisions of "SE2006:group bar:March Deliverables"
Jump to navigation
Jump to search
(A submission of the March Deliverables) |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | '''"Over-ambitious projects: the theme of this semester!"''' | ||
| + | |||
=March Deliverables= | =March Deliverables= | ||
| + | |||
| + | We use [http://www.eclipse.org Eclipse] for software development. We highly recommend using it to check out our project from CVS, run the program & tests, etc. There's a local copy in <code>codd:/p0/tmcnulty</code>. | ||
| + | |||
As requested from Chris' email: | As requested from Chris' email: | ||
1) API Documentation | 1) API Documentation | ||
*Developer documentation on usage | *Developer documentation on usage | ||
| − | **At this point we do not have API to the | + | **At this point we do not have API to the data store. We could write a quick hack in PHP but would rather spend the time to do it well in Java. See our complete [[SE2006:group_bar:todo|TODO list]] for more details on where we stand. |
| − | **We have an API for actually scraping Data. See http://cs.earlham.edu/~bar/doc/ | + | **We have an API for actually scraping Data written in java. See http://cs.earlham.edu/~bar/doc/ for the documentation |
*How to add data new sources | *How to add data new sources | ||
| − | ** | + | **Implement the SourceDefinition class according to the instructions on this page: http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/SourceDefinition.html |
2) Test harness (with instructions) for the API | 2) Test harness (with instructions) for the API | ||
| − | *We use JUnit, and it must run from Eclipse (for now). Other hooks (to use it) coming soon. | + | *We use JUnit, and it must run from Eclipse (for now). Other hooks (to use it) coming soon. (Alex & Colin?) |
| + | *See the [http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/testing/AllTests.html AllTests] documentation for instructions on running the tests in Eclipse. | ||
| + | *For information about the test case coverage see the [http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/testing/SchemaTest.html Schema Tests] and [http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/testing/SourceTest.html Source Tests] | ||
3) Data store information | 3) Data store information | ||
*The data dictionary itself | *The data dictionary itself | ||
| − | **Postgres | + | **Postgres database 'tobias' on millie; user 'tobias' password 'tobias' (will replace this with a bar database once that's setup) |
*Scripts/instructions for creating the schema in the database instance | *Scripts/instructions for creating the schema in the database instance | ||
**There are none because this is done dynamically by our code. (Based on SourceDefinition, see above URL.) | **There are none because this is done dynamically by our code. (Based on SourceDefinition, see above URL.) | ||
*Scripts/instructions to populate the database with your data sources and their source information | *Scripts/instructions to populate the database with your data sources and their source information | ||
**See above pointer. Just run the java program, and the Scheduler will take care of all the nitty/gritty details. | **See above pointer. Just run the java program, and the Scheduler will take care of all the nitty/gritty details. | ||
Latest revision as of 16:52, 31 March 2006
"Over-ambitious projects: the theme of this semester!"
March Deliverables
We use Eclipse for software development. We highly recommend using it to check out our project from CVS, run the program & tests, etc. There's a local copy in codd:/p0/tmcnulty.
As requested from Chris' email:
1) API Documentation
- Developer documentation on usage
- At this point we do not have API to the data store. We could write a quick hack in PHP but would rather spend the time to do it well in Java. See our complete TODO list for more details on where we stand.
- We have an API for actually scraping Data written in java. See http://cs.earlham.edu/~bar/doc/ for the documentation
- How to add data new sources
- Implement the SourceDefinition class according to the instructions on this page: http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/SourceDefinition.html
2) Test harness (with instructions) for the API
- We use JUnit, and it must run from Eclipse (for now). Other hooks (to use it) coming soon. (Alex & Colin?)
- See the AllTests documentation for instructions on running the tests in Eclipse.
- For information about the test case coverage see the Schema Tests and Source Tests
3) Data store information
- The data dictionary itself
- Postgres database 'tobias' on millie; user 'tobias' password 'tobias' (will replace this with a bar database once that's setup)
- Scripts/instructions for creating the schema in the database instance
- There are none because this is done dynamically by our code. (Based on SourceDefinition, see above URL.)
- Scripts/instructions to populate the database with your data sources and their source information
- See above pointer. Just run the java program, and the Scheduler will take care of all the nitty/gritty details.
