Package: gh-commit-history
Fake Github Commit Historya Pypi package to help fake github historyReport Bug·Request FeatureTable of ContentsAbout The ProjectGetting StartedPrerequisitesInstallationUsageContributingLicenseContactAbout The ProjectA Pypi pakcage to fake github commit history(back to top)Getting StartedTo get a local repo with faked history up and running follow these simple example steps.PrerequisitesEnsure you have python. Follow the steps on the official documentationhttps://www.python.org/downloads/You can check what python version you have with the following commandpython--versionGit is also necessary to run the package. Follow the documentation to install Git:https://github.com/git-guides/install-gitInstallationUpgrade pippipinstall--upgradepipInstall fgch pip packagespipinstallgh-commit-history(back to top)UsageThe fake github commit history generator has many different functionalities to produce various realistic and versatile commit frequencies**General Usage**1. Navigate to the location you wish to fake your history and enter python shell in terminalWindows:
`python`Mac/Linux:`python3`3. Import the module:>> from fgch.commit_generator import generate_commits3. Run the module:>> generate_commits()A new directory titledgithub-historywith a file namedfake-history.txtshould have appeared after the sequence commencesIncluding no parameters will run the default settings4. Create a GitHub Repository with a name of your choice (recommend github-history)5. Push changes into the GitHub RepositoryNavigate to the github-history directoryWindows:cd .\github-history\Mac/Linux:cd /github-historyConnect remote to GitHub Repositorygit remote add origin https://github.com/<your-user-name>/<your-repository-name>.gitEx:git remote add origin https://github.com/Vish-04/github-history.gitPush to Repositorygit push -u origin masterReload your GitHub Profile, and your history should be changed!Parameterscommits_per_day: typeString "int-int", default:"0-3"range between which the number of commits per day is chosen fromstart_date: typeString "MM/DD/YY", default:Nonestart date of fake github history. If None, start date will be a year back from current dateend_date: typeString "MM/DD/YY", default:Noneend date of fake github history. If None, end date will be the current dateworkdays_only: typeBoolean, default:Falserestricts commits to only occur on weekdaysweekend_behavior: typeBoolean, default:Falselowers commit frequency to 0-1 commits on weekendsworking_hours: typeString "int-int", default:9-17determines between what hours in military time to commit betweengradient: typeString, default:Noneincreases commits per day closer to the higher number of commit range over time - choose between 'linear', 'exponential', 'bursts'linear: linearly increases commits per dayexponential: exponentially increases commits per daybursts: increases and decreases commits per day in batches of 3 weeks, mimicking sprints`no_commit_percentage` : type `Float`, default: `0`_float between 0 and 1 that determines what percentage of history to not fake commits too_(back to top)ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull Request(back to top)LicenseDistributed under the MIT License. SeeLICENSEfor more information.(back to top)ContactVishwa Akkati -LinkedIn-vakkati@ucdavis.eduProject Link:https://github.com/Vish-04/fake-github-commit-history(back to top)