Project Instructions
Goal
Get familiar with Web Mining and Applied NLP Python projects and the key areas where we implement and present our work.
The goal is to get a professional Python project running successfully.
Common Workflows
We hope things go well, but sometimes they don't. To avoid repeating common workflows and troubleshooting help in every example project, we've consolidated common steps into one central guide.
The guide provides the detailed instructions needed to complete these professional workflows.
A. Set Up Machine
Complete Workflow A: Set Up Machine if your machine is not ready.
B. Explore Example Project
Follow Workflow B: Explore Example Project.
Explore how the example:
- Retrieves text from a web page.
- Extracts text using BeautifulSoup.
- Calculates word frequencies using Polars.
- Creates a frequency chart and word cloud.
- Records execution details in a project log.
Review the example code and results.
C. Start New Project
Follow Workflow C: Start New Project.
IMPORTANT: New repository name: nlp-01-getting-started-custom.
VERIFY: You have completed git add-commit-push to GitHub at least twice.
D. Apply Skills
Follow Workflow D: Apply Skills.
Progression 1. Your Project Works Like the Example
Ensure your new custom project runs like the example.
Verify that key files have been updated to use your GitHub account and the new custom repository name.
No new analysis or technical modification is required, the project should run the same as the example. Only references to the GitHub account and repository name should be updated.
This project illustrates where (in what folders and files) those common required updates occur (and how to find them). We'll make similar changes in every custom project.
E. Finalize Project
Follow Workflow E: Finalize Project.
Since no analytical changes are required,
docs/index.md needs only minor updates.
Update project-specific links to ensure they point to your GitHub account and the new custom repository name.
Success
- [ ] README.md project-specific links use your GitHub account.
- [ ] README.md project-specific links use your custom repository name.
- [ ] docs/index.md project-specific links use your GitHub account.
- [ ] docs/index.md project-specific links use your custom repository name.
- [ ] pyproject.toml
namehas been changed to use your custom repository name. - [ ] The
src/nlppackage path is unchanged. - [ ] The example script runs successfully and produces its results.
- [ ] All necessary commands are provided and work successfully.
- [ ] Links to the Professional Python Guide (pro-analytics-02) remain unchanged.
- [ ] Commit history shows at least the git add-commit-push history required in the instructions.