Skip to content

Commit 9977525

Browse files
authored
[MNT] fix all URLs and main branch references after move to new org (#641)
fixes all the URLs and `main` branch references after move to new org
1 parent b974e1a commit 9977525

21 files changed

Lines changed: 73 additions & 73 deletions

‎.github/ISSUE_TEMPLATE/workflows/main.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
pull_request:
44
push:
55
branches:
6-
- master
6+
- main
77

88
jobs:
99
pytest:

‎.github/workflows/codecov.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
pull_request:
44
push:
55
branches:
6-
- master
6+
- main
77

88
jobs:
99
codecov:

‎.github/workflows/main.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: pytest
55

66
on:
77
push:
8-
branches: ["master"]
8+
branches: ["main"]
99
pull_request:
10-
branches: ["master"]
10+
branches: ["main"]
1111

1212
jobs:
1313
pytest:

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Please refer to the roadmap for a list of areas that I think PyPortfolioOpt coul
44
from. In addition, the following is always welcome::
55

66
- Improve performance of existing code (but not at the cost of readability) – are there any nice numpy tricks I've missed?
7-
- Add new optimization objective functions. For example, if you think that the best performance metric has not been included, write it into a function (or suggest it in [Issues](https://github.com/robertmartin8/PyPortfolioOpt/issues) and I will have a go).
7+
- Add new optimization objective functions. For example, if you think that the best performance metric has not been included, write it into a function (or suggest it in [Issues](https://github.com/pyportfolio/pyportfolioopt/issues) and I will have a go).
88
- Help me write more tests! If you are someone learning about quant finance and/or unit testing in python, what better way to practice than to write some tests on an open-source project! Feel free to check for edge cases, or test performance on a dataset with more stocks.
99

1010
## Guidelines
@@ -31,13 +31,13 @@ I would appreciate if changes are accompanied by relevant documentation – it d
3131

3232
## Questions
3333

34-
If you have any questions related to the project, it is probably easiest to [raise an issue](https://github.com/robertmartin8/PyPortfolioOpt/issues), and I will tag it as a question.
34+
If you have any questions related to the project, it is probably easiest to [raise an issue](https://github.com/pyportfolio/pyportfolioopt/issues), and I will tag it as a question.
3535

3636
If you have questions unrelated to the project, drop me an email – contact details can be found on my [website](https://reasonabledeviations.com/about/)
3737

3838
## Bugs/issues
3939

40-
If you find any bugs or the portfolio optimization is not working as expected, feel free to [raise an issue](https://github.com/robertmartin8/PyPortfolioOpt/issues). I would ask that you provide the following information in the issue:
40+
If you find any bugs or the portfolio optimization is not working as expected, feel free to [raise an issue](https://github.com/pyportfolio/pyportfolioopt/issues). I would ask that you provide the following information in the issue:
4141

4242
- Descriptive title so that other users can see the existing issues
4343
- Operating system, python version, and python distribution (optional).

‎README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img width=60% src="https://github.com/robertmartin8/PyPortfolioOpt/blob/master/media/logo_v1.png?raw=true">
2+
<img width=60% src="https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/media/logo_v1.png?raw=true">
33
</p>
44

55
<!-- buttons -->
@@ -16,16 +16,16 @@
1616
<a href="https://opensource.org/licenses/MIT">
1717
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg"
1818
alt="MIT license"></a> &nbsp;
19-
<a href="https://github.com/robertmartin8/PyPortfolioOpt/actions">
20-
<img src="https://github.com/robertmartin8/PyPortfolioOpt/actions/workflows/main.yml/badge.svg?branch=master"
19+
<a href="https://github.com/pyportfolio/pyportfolioopt/actions">
20+
<img src="https://github.com/pyportfolio/pyportfolioopt/actions/workflows/main.yml/badge.svg?branch=main"
2121
alt="build"></a> &nbsp;
22-
<a href="https://app.codecov.io/gh/robertmartin8/PyPortfolioOpt">
23-
<img src="https://codecov.io/github/robertmartin8/PyPortfolioOpt/coverage.svg?branch=main"
22+
<a href="https://app.codecov.io/gh/pyportfolio/pyportfolioopt">
23+
<img src="https://codecov.io/github/pyportfolio/pyportfolioopt/coverage.svg?branch=main"
2424
alt="codecov"></a> &nbsp;
2525
<a href="https://pepy.tech/project/pyportfolioopt">
2626
<img src="https://pepy.tech/badge/pyportfolioopt"
2727
alt="downloads"></a> &nbsp;
28-
<a href="https://mybinder.org/v2/gh/robertmartin8/pyportfolioopt/master/?filepath=cookbook">
28+
<a href="https://mybinder.org/v2/gh/pyportfolio/pyportfolioopt/main/?filepath=cookbook">
2929
<img src="https://mybinder.org/badge_logo.svg"
3030
alt="binder"></a> &nbsp;
3131
</p>
@@ -45,10 +45,10 @@ in a risk-efficient way.
4545

4646
PyPortfolioOpt is now being maintained by [Tuan Tran](https://github.com/88d52bdba0366127fffca9dfa93895).
4747

48-
Head over to the **[documentation on ReadTheDocs](https://pyportfolioopt.readthedocs.io/en/latest/)** to get an in-depth look at the project, or check out the [cookbook](https://github.com/robertmartin8/PyPortfolioOpt/tree/master/cookbook) to see some examples showing the full process from downloading data to building a portfolio.
48+
Head over to the **[documentation on ReadTheDocs](https://pyportfolioopt.readthedocs.io/en/latest/)** to get an in-depth look at the project, or check out the [cookbook](https://github.com/pyportfolio/pyportfolioopt/tree/main/cookbook) to see some examples showing the full process from downloading data to building a portfolio.
4949

5050
<center>
51-
<img src="https://github.com/robertmartin8/PyPortfolioOpt/blob/master/media/conceptual_flowchart_v2.png?raw=true" style="width:70%;"/>
51+
<img src="https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/media/conceptual_flowchart_v2.png?raw=true" style="width:70%;"/>
5252
</center>
5353

5454
## Table of contents
@@ -74,7 +74,7 @@ Head over to the **[documentation on ReadTheDocs](https://pyportfolioopt.readthe
7474

7575
## Getting started
7676

77-
If you would like to play with PyPortfolioOpt interactively in your browser, you may launch Binder [here](https://mybinder.org/v2/gh/robertmartin8/pyportfolioopt/master). It takes a
77+
If you would like to play with PyPortfolioOpt interactively in your browser, you may launch Binder [here](https://mybinder.org/v2/gh/pyportfolio/pyportfolioopt/main). It takes a
7878
while to set up, but it lets you try out the cookbook recipes without having to deal with all of the requirements.
7979

8080
_Note: macOS users will need to install [Command Line Tools](https://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/)._
@@ -126,13 +126,13 @@ For more information, please read [this guide](https://docker-curriculum.com/#in
126126
If you would like to make major changes to integrate this with your proprietary system, it probably makes sense to clone this repository and to just use the source code.
127127

128128
```bash
129-
git clone https://github.com/robertmartin8/PyPortfolioOpt
129+
git clone https://github.com/pyportfolio/pyportfolioopt
130130
```
131131

132132
Alternatively, you could try:
133133

134134
```bash
135-
pip install -e git+https://github.com/robertmartin8/PyPortfolioOpt.git
135+
pip install -e git+https://github.com/pyportfolio/pyportfolioopt.git
136136
```
137137

138138
## A quick example
@@ -211,14 +211,14 @@ Discrete allocation: {'GOOG': 1, 'AAPL': 4, 'FB': 12, 'BABA': 4, 'BBY': 2,
211211
Funds remaining: $11.89
212212
```
213213

214-
_Disclaimer: nothing about this project constitues investment advice, and the author bears no responsibiltiy for your subsequent investment decisions. Please refer to the [license](https://github.com/robertmartin8/PyPortfolioOpt/blob/master/LICENSE.txt) for more information._
214+
_Disclaimer: nothing about this project constitues investment advice, and the author bears no responsibiltiy for your subsequent investment decisions. Please refer to the [license](https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/LICENSE.txt) for more information._
215215

216216
## An overview of classical portfolio optimization methods
217217

218218
Harry Markowitz's 1952 paper is the undeniable classic, which turned portfolio optimization from an art into a science. The key insight is that by combining assets with different expected returns and volatilities, one can decide on a mathematically optimal allocation which minimises the risk for a target return – the set of all such optimal portfolios is referred to as the **efficient frontier**.
219219

220220
<center>
221-
<img src="https://github.com/robertmartin8/PyPortfolioOpt/blob/master/media/efficient_frontier_white.png?raw=true" style="width:60%;"/>
221+
<img src="https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/media/efficient_frontier_white.png?raw=true" style="width:60%;"/>
222222
</center>
223223

224224
Although much development has been made in the subject, more than half a century later, Markowitz's core ideas are still fundamentally important and see daily use in many portfolio management firms.
@@ -236,7 +236,7 @@ components while still making use of the framework that PyPortfolioOpt provides.
236236

237237
## Features
238238

239-
In this section, we detail some of PyPortfolioOpt's available functionality. More examples are offered in the Jupyter notebooks [here](https://github.com/robertmartin8/PyPortfolioOpt/tree/master/cookbook). Another good resource is the [tests](https://github.com/robertmartin8/PyPortfolioOpt/tree/master/tests).
239+
In this section, we detail some of PyPortfolioOpt's available functionality. More examples are offered in the Jupyter notebooks [here](https://github.com/pyportfolio/pyportfolioopt/tree/main/cookbook). Another good resource is the [tests](https://github.com/pyportfolio/pyportfolioopt/tree/main/tests).
240240

241241
A far more comprehensive version of this can be found on [ReadTheDocs](https://pyportfolioopt.readthedocs.io/en/latest/), as well as possible extensions for more advanced users.
242242

@@ -272,7 +272,7 @@ The covariance matrix encodes not just the volatility of an asset, but also how
272272
- implemented in `sklearn.covariance`
273273

274274
<p align="center">
275-
<img width=60% src="https://github.com/robertmartin8/PyPortfolioOpt/blob/master/media/corrplot_white.png?raw=true">
275+
<img width=60% src="https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/media/corrplot_white.png?raw=true">
276276
</p>
277277

278278
(This plot was generated using `plotting.plot_covariance`)
@@ -420,7 +420,7 @@ BibTex::
420420

421421
## Contributing
422422

423-
Contributions are _most welcome_. Have a look at the [Contribution Guide](https://github.com/robertmartin8/PyPortfolioOpt/blob/master/CONTRIBUTING.md) for more.
423+
Contributions are _most welcome_. Have a look at the [Contribution Guide](https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/CONTRIBUTING.md) for more.
424424

425425
I'd like to thank all of the people who have contributed to PyPortfolioOpt since its release in 2018.
426426
Special shout-outs to:

‎cookbook/1-RiskReturnModels.ipynb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
"\n",
1212
"In this section, we compare how well the different risk models predict an out-of-sample covariance matrix, and how well the different returns models predict out-of-sample returns.\n",
1313
"\n",
14-
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
14+
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
1515
" \n",
16-
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/robertmartin8/PyPortfolioOpt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
16+
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/cookbook/1-RiskReturnModels.ipynb)\n",
1717
" \n",
18-
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
18+
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
1919
" \n",
20-
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
20+
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/pyportfolio/pyportfolioopt/blob/master/cookbook/1-RiskReturnModels.ipynb)\n",
2121
"\n",
2222
"## Risk models"
2323
]
@@ -37,7 +37,7 @@
3737
"!pip install pandas numpy matplotlib PyPortfolioOpt\n",
3838
"import os\n",
3939
"if not os.path.isdir('data'):\n",
40-
" os.system('git clone https://github.com/robertmartin8/PyPortfolioOpt.git')\n",
40+
" os.system('git clone https://github.com/pyportfolio/pyportfolioopt.git')\n",
4141
" os.chdir('PyPortfolioOpt/cookbook')"
4242
]
4343
},

‎cookbook/2-Mean-Variance-Optimisation.ipynb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@
3333
"\n",
3434
"To download data, we will use `yfinance`, an excellent library that provides free price data from Yahoo Finance, no API key needed.\n",
3535
"\n",
36-
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)\n",
36+
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)\n",
3737
" \n",
38-
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/robertmartin8/PyPortfolioOpt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)\n",
38+
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/cookbook/2-Mean-Variance-Optimisation.ipynb)\n",
3939
" \n",
40-
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)\n",
40+
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)\n",
4141
" \n",
42-
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)"
42+
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/pyportfolio/pyportfolioopt/blob/master/cookbook/2-Mean-Variance-Optimisation.ipynb)"
4343
]
4444
},
4545
{
@@ -57,7 +57,7 @@
5757
"!pip install pandas numpy matplotlib yfinance PyPortfolioOpt\n",
5858
"import os\n",
5959
"if not os.path.isdir('data'):\n",
60-
" os.system('git clone https://github.com/robertmartin8/PyPortfolioOpt.git')\n",
60+
" os.system('git clone https://github.com/pyportfolio/pyportfolioopt.git')\n",
6161
" os.chdir('PyPortfolioOpt/cookbook')"
6262
]
6363
},

‎cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@
2020
"\n",
2121
"As discussed in the previous notebook, assets are an exogenous input (i.e you must come up with a list of tickers). We will use `yfinance` to download data for thesee tickers\n",
2222
"\n",
23-
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)\n",
23+
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)\n",
2424
" \n",
25-
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/robertmartin8/PyPortfolioOpt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)\n",
25+
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)\n",
2626
" \n",
27-
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)\n",
27+
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)\n",
2828
" \n",
29-
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)"
29+
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/pyportfolio/pyportfolioopt/blob/master/cookbook/3-Advanced-Mean-Variance-Optimisation.ipynb)"
3030
]
3131
},
3232
{
@@ -87,7 +87,7 @@
8787
"!pip install pandas numpy matplotlib yfinance PyPortfolioOpt\n",
8888
"import os\n",
8989
"if not os.path.isdir('data'):\n",
90-
" os.system('git clone https://github.com/robertmartin8/PyPortfolioOpt.git')\n",
90+
" os.system('git clone https://github.com/pyportfolio/pyportfolioopt.git')\n",
9191
" os.chdir('PyPortfolioOpt/cookbook')"
9292
]
9393
},

‎cookbook/4-Black-Litterman-Allocation.ipynb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@
2424
"In addition to price data, constructing a market prior requires market-caps.\n",
2525
"\n",
2626
"\n",
27-
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)\n",
27+
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)\n",
2828
" \n",
29-
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/robertmartin8/PyPortfolioOpt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)\n",
29+
"[![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/cookbook/4-Black-Litterman-Allocation.ipynb)\n",
3030
" \n",
31-
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)\n",
31+
"[![Gradient](https://assets.paperspace.io/img/gradient-badge.svg)](https://console.paperspace.com/github/pyportfolio/pyportfolioopt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)\n",
3232
" \n",
33-
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/robertmartin8/PyPortfolioOpt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)"
33+
"[![Open In SageMaker Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/pyportfolio/pyportfolioopt/blob/master/cookbook/4-Black-Litterman-Allocation.ipynb)"
3434
]
3535
},
3636
{
@@ -48,7 +48,7 @@
4848
"!pip install pandas numpy matplotlib yfinance PyPortfolioOpt\n",
4949
"import os\n",
5050
"if not os.path.isdir('data'):\n",
51-
" os.system('git clone https://github.com/robertmartin8/PyPortfolioOpt.git')\n",
51+
" os.system('git clone https://github.com/pyportfolio/pyportfolioopt.git')\n",
5252
" os.chdir('PyPortfolioOpt/cookbook')"
5353
]
5454
},

0 commit comments

Comments
 (0)